shiguredo_http11 2026.1.0

HTTP/1.1 Library
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
//! ETag ヘッダーパース (RFC 9110)
//!
//! ## 概要
//!
//! RFC 9110 Section 8.8.3 に基づいた ETag ヘッダーのパースを提供します。
//!
//! ## 使い方
//!
//! ```rust
//! use shiguredo_http11::etag::EntityTag;
//!
//! // Strong ETag
//! let etag = EntityTag::parse("\"abc123\"").unwrap();
//! assert!(etag.is_strong());
//! assert_eq!(etag.tag(), "abc123");
//!
//! // Weak ETag
//! let etag = EntityTag::parse("W/\"abc123\"").unwrap();
//! assert!(etag.is_weak());
//! assert_eq!(etag.tag(), "abc123");
//! ```

use core::fmt;

/// ETag パースエラー
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ETagError {
    /// 空の入力
    Empty,
    /// 不正な形式
    InvalidFormat,
    /// 引用符が見つからない
    MissingQuote,
    /// 不正な文字
    InvalidCharacter,
}

impl fmt::Display for ETagError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            ETagError::Empty => write!(f, "empty etag"),
            ETagError::InvalidFormat => write!(f, "invalid etag format"),
            ETagError::MissingQuote => write!(f, "missing quote in etag"),
            ETagError::InvalidCharacter => write!(f, "invalid character in etag"),
        }
    }
}

impl std::error::Error for ETagError {}

/// Entity Tag (ETag)
///
/// RFC 9110 Section 8.8.3
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct EntityTag {
    /// Weak フラグ
    weak: bool,
    /// タグ値 (引用符なし)
    tag: String,
}

impl EntityTag {
    /// ETag ヘッダー文字列をパース
    ///
    /// # 例
    ///
    /// ```rust
    /// use shiguredo_http11::etag::EntityTag;
    ///
    /// // Strong ETag
    /// let etag = EntityTag::parse("\"v1.0\"").unwrap();
    /// assert!(etag.is_strong());
    ///
    /// // Weak ETag
    /// let etag = EntityTag::parse("W/\"v1.0\"").unwrap();
    /// assert!(etag.is_weak());
    /// ```
    pub fn parse(input: &str) -> Result<Self, ETagError> {
        let input = input.trim();
        if input.is_empty() {
            return Err(ETagError::Empty);
        }

        // RFC 9110 Section 8.8.3: weak = %s"W/" (case-sensitive)
        // 小文字 w/ は許可しない
        let (weak, rest) = if let Some(rest) = input.strip_prefix("W/") {
            (true, rest)
        } else {
            (false, input)
        };

        // 引用符で囲まれていることを確認
        if !rest.starts_with('"') {
            return Err(ETagError::MissingQuote);
        }

        let end_quote = rest[1..].find('"').ok_or(ETagError::MissingQuote)?;
        let tag = &rest[1..1 + end_quote];

        // タグの文字を検証 (etagc: %x21 / %x23-7E / obs-text)
        for b in tag.bytes() {
            if !is_etagc(b) {
                return Err(ETagError::InvalidCharacter);
            }
        }

        // 閉じ引用符の後に余剰文字がないことを確認
        let after_quote = &rest[2 + end_quote..];
        if !after_quote.is_empty() {
            return Err(ETagError::InvalidFormat);
        }

        Ok(EntityTag {
            weak,
            tag: tag.to_string(),
        })
    }

    /// 新しい Strong ETag を作成
    pub fn strong(tag: &str) -> Result<Self, ETagError> {
        for b in tag.bytes() {
            if !is_etagc(b) {
                return Err(ETagError::InvalidCharacter);
            }
        }
        Ok(EntityTag {
            weak: false,
            tag: tag.to_string(),
        })
    }

    /// 新しい Weak ETag を作成
    pub fn weak(tag: &str) -> Result<Self, ETagError> {
        for b in tag.bytes() {
            if !is_etagc(b) {
                return Err(ETagError::InvalidCharacter);
            }
        }
        Ok(EntityTag {
            weak: true,
            tag: tag.to_string(),
        })
    }

    /// Weak ETag かどうか
    pub fn is_weak(&self) -> bool {
        self.weak
    }

    /// Strong ETag かどうか
    pub fn is_strong(&self) -> bool {
        !self.weak
    }

    /// タグ値を取得 (引用符なし)
    pub fn tag(&self) -> &str {
        &self.tag
    }

    /// Strong 比較 (RFC 9110 Section 8.8.3.2)
    ///
    /// 両方が Strong ETag で、タグ値が同一の場合に true
    pub fn strong_compare(&self, other: &EntityTag) -> bool {
        !self.weak && !other.weak && self.tag == other.tag
    }

    /// Weak 比較 (RFC 9110 Section 8.8.3.2)
    ///
    /// タグ値が同一の場合に true (weak フラグは無視)
    pub fn weak_compare(&self, other: &EntityTag) -> bool {
        self.tag == other.tag
    }
}

impl fmt::Display for EntityTag {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        if self.weak {
            write!(f, "W/\"{}\"", self.tag)
        } else {
            write!(f, "\"{}\"", self.tag)
        }
    }
}

/// etagc 文字 (RFC 9110)
/// %x21 / %x23-7E / obs-text
fn is_etagc(b: u8) -> bool {
    b == 0x21 || (0x23..=0x7E).contains(&b) || b >= 0x80
}

/// ETag リストを引用符を考慮してカンマ分割する
///
/// etagc (RFC 9110 Section 8.8.3) はカンマを含み得るため、
/// DQUOTE 内のカンマはデリミタとして扱わない
fn split_etag_list_raw(input: &str) -> Vec<&str> {
    let mut parts = Vec::new();
    let mut start = 0;
    let mut in_quotes = false;
    let bytes = input.as_bytes();

    for i in 0..bytes.len() {
        match bytes[i] {
            b'"' => in_quotes = !in_quotes,
            b',' if !in_quotes => {
                parts.push(&input[start..i]);
                start = i + 1;
            }
            _ => {}
        }
    }
    parts.push(&input[start..]);
    parts
}

/// ETag リストをパース (If-Match, If-None-Match 用)
///
/// カンマ区切りの ETag リストをパースします。
/// `*` (ワイルドカード) もサポートします。
pub fn parse_etag_list(input: &str) -> Result<ETagList, ETagError> {
    let input = input.trim();
    if input.is_empty() {
        return Err(ETagError::Empty);
    }

    if input == "*" {
        return Ok(ETagList::Any);
    }

    let mut etags = Vec::new();
    for part in split_etag_list_raw(input) {
        let part = part.trim();
        if !part.is_empty() {
            etags.push(EntityTag::parse(part)?);
        }
    }

    if etags.is_empty() {
        return Err(ETagError::Empty);
    }

    Ok(ETagList::Tags(etags))
}

/// ETag リスト
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ETagList {
    /// ワイルドカード (*)
    Any,
    /// ETag のリスト
    Tags(Vec<EntityTag>),
}

impl ETagList {
    /// ワイルドカードかどうか
    pub fn is_any(&self) -> bool {
        matches!(self, ETagList::Any)
    }

    /// 指定した ETag が含まれるか (Weak 比較)
    pub fn contains_weak(&self, etag: &EntityTag) -> bool {
        match self {
            ETagList::Any => true,
            ETagList::Tags(tags) => tags.iter().any(|t| t.weak_compare(etag)),
        }
    }

    /// 指定した ETag が含まれるか (Strong 比較)
    pub fn contains_strong(&self, etag: &EntityTag) -> bool {
        match self {
            ETagList::Any => true,
            ETagList::Tags(tags) => tags.iter().any(|t| t.strong_compare(etag)),
        }
    }
}

impl fmt::Display for ETagList {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            ETagList::Any => write!(f, "*"),
            ETagList::Tags(tags) => {
                let s: Vec<String> = tags.iter().map(|t| t.to_string()).collect();
                write!(f, "{}", s.join(", "))
            }
        }
    }
}

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

    #[test]
    fn test_parse_strong() {
        let etag = EntityTag::parse("\"abc123\"").unwrap();
        assert!(etag.is_strong());
        assert_eq!(etag.tag(), "abc123");
    }

    #[test]
    fn test_parse_weak() {
        let etag = EntityTag::parse("W/\"abc123\"").unwrap();
        assert!(etag.is_weak());
        assert_eq!(etag.tag(), "abc123");
    }

    #[test]
    fn test_parse_weak_lowercase_rejected() {
        // RFC 9110 Section 8.8.3: weak = %s"W/" (case-sensitive)
        // 小文字 w/ は許可されない
        assert!(EntityTag::parse("w/\"abc123\"").is_err());
    }

    #[test]
    fn test_parse_trailing_content_rejected() {
        // 閉じ引用符の後に余剰文字がある場合は拒否
        assert!(EntityTag::parse("\"abc\" extra").is_err());
        assert!(EntityTag::parse("W/\"abc\"extra").is_err());
    }

    #[test]
    fn test_parse_empty_tag() {
        let etag = EntityTag::parse("\"\"").unwrap();
        assert_eq!(etag.tag(), "");
    }

    #[test]
    fn test_parse_missing_quote() {
        assert!(EntityTag::parse("abc").is_err());
        assert!(EntityTag::parse("\"abc").is_err());
        assert!(EntityTag::parse("abc\"").is_err());
    }

    #[test]
    fn test_parse_empty() {
        assert!(EntityTag::parse("").is_err());
    }

    #[test]
    fn test_display_strong() {
        let etag = EntityTag::strong("v1.0").unwrap();
        assert_eq!(etag.to_string(), "\"v1.0\"");
    }

    #[test]
    fn test_display_weak() {
        let etag = EntityTag::weak("v1.0").unwrap();
        assert_eq!(etag.to_string(), "W/\"v1.0\"");
    }

    #[test]
    fn test_strong_compare() {
        let e1 = EntityTag::strong("abc").unwrap();
        let e2 = EntityTag::strong("abc").unwrap();
        let e3 = EntityTag::weak("abc").unwrap();

        assert!(e1.strong_compare(&e2));
        assert!(!e1.strong_compare(&e3));
        assert!(!e3.strong_compare(&e1));
    }

    #[test]
    fn test_weak_compare() {
        let e1 = EntityTag::strong("abc").unwrap();
        let e2 = EntityTag::weak("abc").unwrap();
        let e3 = EntityTag::strong("xyz").unwrap();

        assert!(e1.weak_compare(&e2));
        assert!(e2.weak_compare(&e1));
        assert!(!e1.weak_compare(&e3));
    }

    #[test]
    fn test_parse_etag_list() {
        let list = parse_etag_list("\"a\", \"b\", W/\"c\"").unwrap();
        match list {
            ETagList::Tags(tags) => {
                assert_eq!(tags.len(), 3);
                assert_eq!(tags[0].tag(), "a");
                assert!(tags[0].is_strong());
                assert_eq!(tags[1].tag(), "b");
                assert_eq!(tags[2].tag(), "c");
                assert!(tags[2].is_weak());
            }
            _ => panic!("expected Tags"),
        }
    }

    #[test]
    fn test_parse_etag_list_any() {
        let list = parse_etag_list("*").unwrap();
        assert!(list.is_any());
    }

    #[test]
    fn test_etag_list_contains() {
        let list = parse_etag_list("\"a\", W/\"b\"").unwrap();
        let etag_a = EntityTag::strong("a").unwrap();
        let etag_b = EntityTag::strong("b").unwrap();
        let etag_c = EntityTag::strong("c").unwrap();

        assert!(list.contains_weak(&etag_a));
        assert!(list.contains_weak(&etag_b));
        assert!(!list.contains_weak(&etag_c));

        assert!(list.contains_strong(&etag_a));
        assert!(!list.contains_strong(&etag_b)); // W/"b" は strong compare で false
    }

    #[test]
    fn test_parse_etag_list_with_comma_in_tag() {
        // etagc はカンマを含み得る (0x2C は %x23-7E の範囲内)
        let list = parse_etag_list("\"a,b\", \"c\"").unwrap();
        match list {
            ETagList::Tags(tags) => {
                assert_eq!(tags.len(), 2);
                assert_eq!(tags[0].tag(), "a,b");
                assert_eq!(tags[1].tag(), "c");
            }
            _ => panic!("expected Tags"),
        }
    }

    #[test]
    fn test_parse_etag_list_weak_with_comma_in_tag() {
        let list = parse_etag_list("W/\"x,y\", \"z\"").unwrap();
        match list {
            ETagList::Tags(tags) => {
                assert_eq!(tags.len(), 2);
                assert_eq!(tags[0].tag(), "x,y");
                assert!(tags[0].is_weak());
                assert_eq!(tags[1].tag(), "z");
            }
            _ => panic!("expected Tags"),
        }
    }

    #[test]
    fn test_etag_list_display() {
        let list = parse_etag_list("\"a\", \"b\"").unwrap();
        assert_eq!(list.to_string(), "\"a\", \"b\"");

        let any = parse_etag_list("*").unwrap();
        assert_eq!(any.to_string(), "*");
    }
}