qubit-mime 0.5.2

MIME type detection utilities for Rust based on filename glob rules and content magic
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
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
/*******************************************************************************
 *
 *    Copyright (c) 2026 Haixing Hu.
 *
 *    SPDX-License-Identifier: Apache-2.0
 *
 *    Licensed under the Apache License, Version 2.0.
 *
 ******************************************************************************/
//! Repository of MIME types parsed from shared MIME-info XML.

use std::borrow::Cow;
use std::collections::HashMap;

use qubit_codec::{
    CIntegerLiteralCodec,
    CStringLiteralCodec,
    CodecError,
    HexCodec,
};
use roxmltree::{
    Document,
    Node,
};

use crate::{
    MagicValueType,
    MimeDetectionPolicy,
    MimeError,
    MimeGlob,
    MimeMagic,
    MimeMagicMatcher,
    MimeResult,
    MimeType,
    MimeTypeBuilder,
};

/// A repository of MIME types and detection indexes.
#[derive(Debug, Clone)]
pub struct MimeRepository {
    mime_types: Vec<MimeType>,
    name_map: HashMap<String, usize>,
    literal_globs: HashMap<String, Vec<GlobEntry>>,
    extension_globs: HashMap<String, Vec<GlobEntry>>,
    other_globs: Vec<GlobEntry>,
    max_test_bytes: usize,
}

#[derive(Debug, Clone)]
struct GlobEntry {
    glob: MimeGlob,
    mime_index: usize,
}

impl MimeRepository {
    /// Parses a MIME repository from shared MIME-info XML.
    ///
    /// # Parameters
    /// - `xml`: XML document whose root element is `mime-info`.
    ///
    /// # Returns
    /// A parsed repository with filename and alias indexes.
    ///
    /// # Errors
    /// Returns [`MimeError`](crate::MimeError) when XML is malformed or a rule contains an
    /// unsupported value.
    pub fn from_xml(xml: &str) -> MimeResult<Self> {
        let xml = strip_doctype(xml);
        let document = Document::parse(&xml)?;
        let root = document.root_element();
        if root.tag_name().name() != "mime-info" {
            return Err(MimeError::invalid_element(
                root.tag_name().name(),
                "root element must be <mime-info>",
            ));
        }
        let mut repository = Self::empty();
        for child in root.children().filter(Node::is_element) {
            if child.tag_name().name() == "mime-type" {
                repository.add_mime_type(parse_mime_type(child)?);
            }
        }
        Ok(repository)
    }

    /// Creates an empty repository.
    ///
    /// # Returns
    /// A repository with no MIME types.
    pub fn empty() -> Self {
        Self {
            mime_types: Vec::new(),
            name_map: HashMap::new(),
            literal_globs: HashMap::new(),
            extension_globs: HashMap::new(),
            other_globs: Vec::new(),
            max_test_bytes: 0,
        }
    }

    /// Gets all MIME types in database order.
    ///
    /// # Returns
    /// Slice of all parsed MIME types.
    pub fn all(&self) -> &[MimeType] {
        &self.mime_types
    }

    /// Gets a MIME type by canonical name or alias.
    ///
    /// # Parameters
    /// - `name`: MIME type name or alias.
    ///
    /// # Returns
    /// The matching MIME type, or `None`.
    pub fn get(&self, name: &str) -> Option<&MimeType> {
        self.name_map
            .get(&normalize_mime_name(name))
            .and_then(|index| self.mime_types.get(*index))
    }

    /// Gets the maximum number of bytes needed by any magic rule.
    ///
    /// # Returns
    /// Buffer size sufficient for all content magic checks.
    pub fn max_test_bytes(&self) -> usize {
        self.max_test_bytes
    }

    /// Detects MIME types from a filename.
    ///
    /// # Parameters
    /// - `filename`: File path or basename. Only the final path component is used.
    ///
    /// # Returns
    /// Matching MIME types ordered by best glob weight and pattern length. Returns
    /// an empty vector when no glob matches.
    pub fn detect_by_filename(&self, filename: &str) -> Vec<&MimeType> {
        let exact_filename = filename_from_path(filename);
        if exact_filename.is_empty() {
            return Vec::new();
        }
        let lookup_filename = exact_filename.to_lowercase();
        let mut result = GlobDetectionResult::new();
        if let Some(entries) = self.literal_globs.get(&lookup_filename) {
            result.add_matching_entries(entries, exact_filename);
        }
        for extension in extension_suffixes(&lookup_filename) {
            if let Some(entries) = self.extension_globs.get(extension) {
                result.add_matching_entries(entries, exact_filename);
            }
        }
        for entry in &self.other_globs {
            if entry.glob.matches(exact_filename) {
                result.compare_add(entry);
            }
        }
        result
            .entries
            .into_iter()
            .filter_map(|entry| self.mime_types.get(entry.mime_index))
            .collect()
    }

    /// Detects MIME types from content bytes.
    ///
    /// # Parameters
    /// - `bytes`: Content prefix to test against magic rules.
    ///
    /// # Returns
    /// Matching MIME types ordered by highest magic priority. Returns an empty
    /// vector when no magic rule matches.
    pub fn detect_by_content(&self, bytes: &[u8]) -> Vec<&MimeType> {
        let mut result = MagicDetectionResult::new();
        for mime_type in &self.mime_types {
            for magic in mime_type.magics() {
                let priority = magic.priority();
                if priority >= result.best_priority && magic.matches(bytes) {
                    result.compare_add(priority, mime_type);
                }
            }
        }
        result.mime_types
    }

    /// Detects MIME type by merging filename and content results.
    ///
    /// # Parameters
    /// - `filename`: File path or basename.
    /// - `bytes`: Content prefix to test.
    /// - `policy`: Strategy for resolving filename and content results.
    ///
    /// # Returns
    /// A vector containing the selected MIME type, or an empty vector when no
    /// rule matches.
    pub fn detect(
        &self,
        filename: &str,
        bytes: &[u8],
        policy: MimeDetectionPolicy,
    ) -> Vec<&MimeType> {
        let from_filename = self.detect_by_filename(filename);
        if from_filename.len() == 1 && policy == MimeDetectionPolicy::PreferFilename {
            return from_filename;
        }
        let from_content = self.detect_by_content(bytes);
        merge_results(from_filename, from_content)
    }

    /// Adds a MIME type and updates lookup indexes.
    ///
    /// # Parameters
    /// - `mime_type`: MIME type to insert.
    fn add_mime_type(&mut self, mime_type: MimeType) {
        let mime_index = self.mime_types.len();
        self.index_names(mime_index, &mime_type);
        self.index_globs(mime_index, &mime_type);
        self.index_magics(&mime_type);
        self.mime_types.push(mime_type);
    }

    /// Adds canonical name and aliases to the name index.
    ///
    /// # Parameters
    /// - `mime_index`: Index of `mime_type` in `mime_types`.
    /// - `mime_type`: MIME type to index.
    fn index_names(&mut self, mime_index: usize, mime_type: &MimeType) {
        self.name_map
            .insert(normalize_mime_name(mime_type.name()), mime_index);
        for alias in mime_type.aliases() {
            self.name_map.insert(normalize_mime_name(alias), mime_index);
        }
    }

    /// Adds glob rules to the optimized filename indexes.
    ///
    /// # Parameters
    /// - `mime_index`: Index of `mime_type` in `mime_types`.
    /// - `mime_type`: MIME type to index.
    fn index_globs(&mut self, mime_index: usize, mime_type: &MimeType) {
        for glob in mime_type.globs() {
            let entry = GlobEntry {
                glob: glob.clone(),
                mime_index,
            };
            if let Some(extension) = extension_pattern(glob.pattern()) {
                self.extension_globs
                    .entry(extension.to_lowercase())
                    .or_default()
                    .push(entry);
            } else if is_literal_pattern(glob.pattern()) {
                self.literal_globs
                    .entry(glob.pattern().to_lowercase())
                    .or_default()
                    .push(entry);
            } else {
                self.other_globs.push(entry);
            }
        }
    }

    /// Updates the repository-wide maximum magic read length.
    ///
    /// # Parameters
    /// - `mime_type`: MIME type whose magic rules should be inspected.
    fn index_magics(&mut self, mime_type: &MimeType) {
        for magic in mime_type.magics() {
            self.max_test_bytes = self.max_test_bytes.max(magic.max_test_bytes());
        }
    }
}

#[derive(Debug)]
struct GlobDetectionResult<'a> {
    best_weight: u16,
    best_length: usize,
    entries: Vec<&'a GlobEntry>,
}

impl<'a> GlobDetectionResult<'a> {
    /// Creates an empty glob detection result.
    ///
    /// # Returns
    /// New result with no entries.
    fn new() -> Self {
        Self {
            best_weight: 0,
            best_length: 0,
            entries: Vec::new(),
        }
    }

    /// Adds matching entries that beat or tie the current best result.
    ///
    /// # Parameters
    /// - `entries`: Candidate glob entries.
    /// - `filename`: Original-case filename to test against case-sensitive globs.
    fn add_matching_entries(&mut self, entries: &'a [GlobEntry], filename: &str) {
        for entry in entries {
            if entry.glob.matches(filename) {
                self.compare_add(entry);
            }
        }
    }

    /// Compares one glob entry against the current best result.
    ///
    /// # Parameters
    /// - `entry`: Matching glob entry.
    fn compare_add(&mut self, entry: &'a GlobEntry) {
        let weight = entry.glob.weight();
        let length = entry.glob.pattern().len();
        if self.entries.is_empty() || weight > self.best_weight {
            self.entries.clear();
            self.entries.push(entry);
            self.best_weight = weight;
            self.best_length = length;
        } else if weight == self.best_weight {
            if length > self.best_length {
                self.entries.clear();
                self.entries.push(entry);
                self.best_length = length;
            } else if length == self.best_length {
                self.entries.push(entry);
            }
        }
    }
}

/// Removes a DTD declaration before parsing with `roxmltree`.
///
/// # Parameters
/// - `xml`: Source XML text.
///
/// # Returns
/// Borrowed XML when no DTD exists; otherwise an owned XML string with the DTD
/// declaration removed.
fn strip_doctype(xml: &str) -> Cow<'_, str> {
    let Some(start) = xml.find("<!DOCTYPE") else {
        return Cow::Borrowed(xml);
    };
    let Some(rest) = xml.get(start..) else {
        return Cow::Borrowed(xml);
    };
    let end_offset = rest
        .find("]>")
        .map(|index| index + 2)
        .or_else(|| rest.find('>').map(|index| index + 1));
    let Some(end_offset) = end_offset else {
        return Cow::Borrowed(xml);
    };
    let mut cleaned = String::with_capacity(xml.len().saturating_sub(end_offset));
    cleaned.push_str(&xml[..start]);
    cleaned.push_str(&xml[start + end_offset..]);
    Cow::Owned(cleaned)
}

#[derive(Debug)]
struct MagicDetectionResult<'a> {
    best_priority: u16,
    mime_types: Vec<&'a MimeType>,
}

impl<'a> MagicDetectionResult<'a> {
    /// Creates an empty magic detection result.
    ///
    /// # Returns
    /// New result with no MIME types.
    fn new() -> Self {
        Self {
            best_priority: 0,
            mime_types: Vec::new(),
        }
    }

    /// Compares one content match against the current best result.
    ///
    /// # Parameters
    /// - `priority`: Priority of the matched magic rule.
    /// - `mime_type`: MIME type matched by the rule.
    fn compare_add(&mut self, priority: u16, mime_type: &'a MimeType) {
        if self.mime_types.is_empty() || priority > self.best_priority {
            self.mime_types.clear();
            self.mime_types.push(mime_type);
            self.best_priority = priority;
        } else if priority == self.best_priority && !self.mime_types.contains(&mime_type) {
            self.mime_types.push(mime_type);
        }
    }
}

/// Parses one `mime-type` element.
///
/// # Parameters
/// - `node`: XML element to parse.
///
/// # Returns
/// Parsed MIME type.
///
/// # Errors
/// Returns [`MimeError`](crate::MimeError) when required attributes or child rules are invalid.
fn parse_mime_type(node: Node<'_, '_>) -> MimeResult<MimeType> {
    let name = required_attr(node, "type")?.to_owned();
    let mut builder = MimeTypeBuilder::new(&name);
    for child in node.children().filter(Node::is_element) {
        match child.tag_name().name() {
            "comment" => {
                let language = child.attribute("xml:lang").unwrap_or("");
                builder = builder.description(language, child.text().unwrap_or(""));
            }
            "alias" => builder = builder.alias(required_attr(child, "type")?),
            "sub-class-of" => builder = builder.super_type(required_attr(child, "type")?),
            "glob" => builder = builder.glob(parse_glob(child)?),
            "magic" => builder = builder.magic(parse_magic(child)?),
            _ => {}
        }
    }
    Ok(builder.build())
}

/// Parses one `glob` element.
///
/// # Parameters
/// - `node`: XML element to parse.
///
/// # Returns
/// Parsed glob.
///
/// # Errors
/// Returns [`MimeError`](crate::MimeError) when attributes are invalid.
fn parse_glob(node: Node<'_, '_>) -> MimeResult<MimeGlob> {
    let pattern = required_attr(node, "pattern")?;
    let weight = optional_u16_attr(
        node,
        "weight",
        MimeGlob::MIN_WEIGHT,
        MimeGlob::MAX_WEIGHT,
        MimeGlob::DEFAULT_WEIGHT,
    )?;
    let case_sensitive = optional_bool_attr(node, "case-sensitive", false)?;
    MimeGlob::new(pattern, weight, case_sensitive)
}

/// Parses one `magic` element.
///
/// # Parameters
/// - `node`: XML element to parse.
///
/// # Returns
/// Parsed magic rule.
///
/// # Errors
/// Returns [`MimeError`](crate::MimeError) when priority or matchers are invalid.
fn parse_magic(node: Node<'_, '_>) -> MimeResult<MimeMagic> {
    let priority = optional_u16_attr(
        node,
        "priority",
        MimeMagic::MIN_PRIORITY,
        MimeMagic::MAX_PRIORITY,
        MimeMagic::DEFAULT_PRIORITY,
    )?;
    let matchers: MimeResult<Vec<_>> = node
        .children()
        .filter(Node::is_element)
        .filter(|child| child.tag_name().name() == "match")
        .map(parse_matcher)
        .collect();
    let matchers = matchers?;
    if matchers.is_empty() {
        return Err(MimeError::invalid_element(
            "magic",
            "magic must contain at least one match",
        ));
    }
    Ok(MimeMagic::new(priority, matchers))
}

/// Parses one recursive `match` element.
///
/// # Parameters
/// - `node`: XML element to parse.
///
/// # Returns
/// Parsed magic matcher.
///
/// # Errors
/// Returns [`MimeError`](crate::MimeError) when matcher attributes are invalid.
fn parse_matcher(node: Node<'_, '_>) -> MimeResult<MimeMagicMatcher> {
    let type_name = required_attr(node, "type")?;
    let value_type = MagicValueType::from_name(type_name)
        .ok_or_else(|| MimeError::invalid_attr("match", "type", type_name, "unknown type"))?;
    let (offset_begin, offset_end) = parse_offset(required_attr(node, "offset")?)?;
    let value = parse_value(value_type, required_attr(node, "value")?)?;
    let mask = match node.attribute("mask") {
        Some(mask) => Some(parse_mask(value_type, mask)?),
        None => None,
    };
    let sub_matchers: MimeResult<Vec<_>> = node
        .children()
        .filter(Node::is_element)
        .filter(|child| child.tag_name().name() == "match")
        .map(parse_matcher)
        .collect();
    MimeMagicMatcher::new(
        value_type,
        offset_begin,
        offset_end,
        value,
        mask,
        sub_matchers?,
    )
}

/// Reads a required XML attribute.
///
/// # Parameters
/// - `node`: Element to read from.
/// - `name`: Attribute name.
///
/// # Returns
/// Attribute value.
///
/// # Errors
/// Returns [`MimeError`](crate::MimeError) when the attribute is missing or empty.
fn required_attr<'a>(node: Node<'a, '_>, name: &str) -> MimeResult<&'a str> {
    node.attribute(name)
        .filter(|value| !value.is_empty())
        .ok_or_else(|| {
            MimeError::invalid_attr(
                node.tag_name().name(),
                name,
                "",
                "required attribute is missing",
            )
        })
}

/// Reads an optional bounded `u16` XML attribute.
///
/// # Parameters
/// - `node`: Element to read from.
/// - `name`: Attribute name.
/// - `min`: Minimum allowed value.
/// - `max`: Maximum allowed value.
/// - `default`: Default value when the attribute is absent.
///
/// # Returns
/// Parsed value.
///
/// # Errors
/// Returns [`MimeError`](crate::MimeError) when the value is not an integer or is out of range.
fn optional_u16_attr(
    node: Node<'_, '_>,
    name: &str,
    min: u16,
    max: u16,
    default: u16,
) -> MimeResult<u16> {
    let Some(value) = node.attribute(name) else {
        return Ok(default);
    };
    let parsed = value.parse::<u16>().map_err(|error| {
        MimeError::invalid_attr(node.tag_name().name(), name, value, error.to_string())
    })?;
    if parsed < min || parsed > max {
        return Err(MimeError::invalid_attr(
            node.tag_name().name(),
            name,
            value,
            format!("value must be in {min}..={max}"),
        ));
    }
    Ok(parsed)
}

/// Reads an optional boolean XML attribute.
///
/// # Parameters
/// - `node`: Element to read from.
/// - `name`: Attribute name.
/// - `default`: Default value when the attribute is absent.
///
/// # Returns
/// Parsed boolean value.
///
/// # Errors
/// Returns [`MimeError`](crate::MimeError) when the value is not `true` or `false`.
fn optional_bool_attr(node: Node<'_, '_>, name: &str, default: bool) -> MimeResult<bool> {
    match node.attribute(name) {
        Some("true") => Ok(true),
        Some("false") => Ok(false),
        Some(value) => Err(MimeError::invalid_attr(
            node.tag_name().name(),
            name,
            value,
            "expected true or false",
        )),
        None => Ok(default),
    }
}

/// Parses an offset or offset range.
///
/// # Parameters
/// - `value`: Offset attribute text such as `0` or `0:256`.
///
/// # Returns
/// Inclusive offset range.
///
/// # Errors
/// Returns [`MimeError`](crate::MimeError) when the range is invalid.
fn parse_offset(value: &str) -> MimeResult<(usize, usize)> {
    let (begin, end) = value.split_once(':').map_or((value, value), |parts| parts);
    let offset_begin = parse_usize(begin, "offset")?;
    let offset_end = parse_usize(end, "offset")?;
    if offset_begin > offset_end {
        return Err(MimeError::invalid_attr(
            "match",
            "offset",
            value,
            "offset begin must not exceed offset end",
        ));
    }
    Ok((offset_begin, offset_end))
}

/// Parses a non-negative integer.
///
/// # Parameters
/// - `value`: Number text.
/// - `attribute`: Attribute name used in error messages.
///
/// # Returns
/// Parsed integer.
///
/// # Errors
/// Returns [`MimeError`](crate::MimeError) when the number is invalid.
fn parse_usize(value: &str, attribute: &str) -> MimeResult<usize> {
    value.parse::<usize>().map_err(|error| {
        MimeError::invalid_attr(
            "match",
            attribute,
            value,
            format!("invalid integer: {error}"),
        )
    })
}

/// Parses a magic value attribute.
///
/// # Parameters
/// - `value_type`: Matcher value type.
/// - `value`: Attribute value text.
///
/// # Returns
/// Parsed bytes. Numeric values are stored big-endian.
///
/// # Errors
/// Returns [`MimeError`](crate::MimeError) when the value cannot be decoded.
fn parse_value(value_type: MagicValueType, value: &str) -> MimeResult<Vec<u8>> {
    match value_type {
        MagicValueType::String => parse_c_string_bytes(value),
        _ => parse_numeric_bytes(value_type, value),
    }
}

/// Parses a magic mask attribute.
///
/// # Parameters
/// - `value_type`: Matcher value type.
/// - `value`: Attribute value text.
///
/// # Returns
/// Parsed mask bytes.
///
/// # Errors
/// Returns [`MimeError`](crate::MimeError) when the mask cannot be decoded.
fn parse_mask(value_type: MagicValueType, value: &str) -> MimeResult<Vec<u8>> {
    match value_type {
        MagicValueType::String => parse_hex_bytes(value),
        _ => parse_numeric_bytes(value_type, value),
    }
}

/// Parses a C string literal used by shared MIME-info magic values.
///
/// # Parameters
/// - `value`: Attribute value after XML entity decoding.
///
/// # Returns
/// Decoded bytes.
///
/// # Errors
/// Returns [`MimeError`](crate::MimeError) when the literal cannot be decoded.
fn parse_c_string_bytes(value: &str) -> MimeResult<Vec<u8>> {
    CStringLiteralCodec::new().decode(value).map_err(|error| {
        MimeError::invalid_attr(
            "match",
            "value",
            value,
            format!("invalid C string literal: {error}"),
        )
    })
}

/// Parses a numeric magic value into big-endian bytes.
///
/// # Parameters
/// - `value_type`: Numeric matcher type.
/// - `value`: Numeric text in decimal, octal, or hexadecimal notation.
///
/// # Returns
/// Big-endian bytes with the width required by `value_type`.
///
/// # Errors
/// Returns [`MimeError`](crate::MimeError) when the value is invalid.
fn parse_numeric_bytes(value_type: MagicValueType, value: &str) -> MimeResult<Vec<u8>> {
    let number = CIntegerLiteralCodec::new().decode(value).map_err(|error| {
        MimeError::invalid_attr(
            "match",
            "value",
            value,
            format!("invalid C integer literal: {error}"),
        )
    })?;
    match value_type
        .numeric_width()
        .expect("numeric parser should only receive numeric magic types")
    {
        1 => Ok(vec![number as u8]),
        2 => Ok((number as u16).to_be_bytes().to_vec()),
        4 => Ok((number as u32).to_be_bytes().to_vec()),
        _ => unreachable!("unsupported numeric magic width"),
    }
}

/// Parses `0x` prefixed hex bytes.
///
/// # Parameters
/// - `value`: Hex byte string.
///
/// # Returns
/// Decoded bytes.
///
/// # Errors
/// Returns [`MimeError`](crate::MimeError) when the value is not an
/// even-length hex string or contains non-hex characters.
fn parse_hex_bytes(value: &str) -> MimeResult<Vec<u8>> {
    HexCodec::new()
        .with_prefix("0x")
        .with_ignore_prefix_case(true)
        .decode(value)
        .map_err(|error| match error {
            CodecError::MissingPrefix { .. } => {
                MimeError::invalid_attr("match", "mask", value, "string mask must start with 0x")
            }
            other => MimeError::invalid_attr(
                "match",
                "mask",
                value,
                format!("invalid hex byte: {other}"),
            ),
        })
}

/// Gets normalized MIME type name.
///
/// # Parameters
/// - `name`: MIME type name.
///
/// # Returns
/// Lowercase name for map lookup.
fn normalize_mime_name(name: &str) -> String {
    name.to_lowercase()
}

/// Extracts a basename from a path-like string.
///
/// # Parameters
/// - `path`: Path or basename.
///
/// # Returns
/// Final path component.
fn filename_from_path(path: &str) -> &str {
    path.rsplit(['/', '\\']).next().unwrap_or(path)
}

/// Yields extension suffixes from longest to shortest by scanning dots.
///
/// # Parameters
/// - `filename`: Lowercase basename.
///
/// # Returns
/// Extension suffix slices such as `tar.gz` then `gz`.
fn extension_suffixes(filename: &str) -> Vec<&str> {
    filename
        .match_indices('.')
        .map(|(index, _)| &filename[index + 1..])
        .filter(|extension| !extension.is_empty())
        .collect()
}

/// Detects whether a glob is an extension pattern.
///
/// # Parameters
/// - `pattern`: Glob pattern.
///
/// # Returns
/// Extension without `*.`, or `None` when special glob syntax appears.
fn extension_pattern(pattern: &str) -> Option<&str> {
    let extension = pattern.strip_prefix("*.")?;
    if extension.is_empty()
        || extension
            .chars()
            .any(|ch| matches!(ch, '*' | '?' | '{' | '}' | '!' | '[' | ']' | '^'))
    {
        None
    } else {
        Some(extension)
    }
}

/// Detects whether a glob is a literal pattern.
///
/// # Parameters
/// - `pattern`: Glob pattern.
///
/// # Returns
/// `true` when the pattern contains no glob metacharacters.
fn is_literal_pattern(pattern: &str) -> bool {
    !pattern
        .chars()
        .any(|ch| matches!(ch, '*' | '?' | '{' | '}' | '!' | '[' | ']' | '^'))
}

/// Merges filename and content detection results.
///
/// # Parameters
/// - `from_filename`: Candidates from filename globs.
/// - `from_content`: Candidates from content magic.
///
/// # Returns
/// A single selected MIME type, or an empty vector when neither source matched.
fn merge_results<'a>(
    from_filename: Vec<&'a MimeType>,
    from_content: Vec<&'a MimeType>,
) -> Vec<&'a MimeType> {
    if from_filename.is_empty() {
        return from_content.into_iter().take(1).collect();
    }
    if from_content.is_empty() {
        return from_filename.into_iter().take(1).collect();
    }
    if let Some(common) = from_filename.iter().find(|mime_type| {
        from_content
            .iter()
            .any(|content| content.name() == mime_type.name())
    }) {
        vec![*common]
    } else {
        from_content.into_iter().take(1).collect()
    }
}