escaper 0.1.1

#![deny(clippy::indexing_slicing)]

use std::char;
use std::io::{self, BufRead, Cursor, Write};

use self::DecodeErrKind::*;
use self::DecodeState::*;
use crate::io_support::{self, write_char, CharsError};

#[derive(Debug)]
pub enum DecodeErrKind {
    /// A non-existent named entity was referenced.
    /// Example: &thisentitydoesnotexist
    UnknownEntity,

    /// A numerical escape sequence (&# or &#x) containing an invalid character.
    /// Examples: `&#32a`, `&#xfoo`
    MalformedNumEscape,

    /// A numerical escape sequence (&# or &#x) resolved to an invalid unicode code point.
    /// Example: `&#xffffff`
    InvalidCharacter,

    /// The input ended prematurely (ie. inside an unterminated named entity sequence).
    PrematureEnd,

    /// An IO error occured.
    IoError(io::Error),

    /// The supplied Reader produces invalid UTF-8.
    EncodingError,
}

impl PartialEq for DecodeErrKind {
    fn eq(&self, other: &DecodeErrKind) -> bool {
        match (self, other) {
            (&UnknownEntity, &UnknownEntity) => true,
            (&MalformedNumEscape, &MalformedNumEscape) => true,
            (&InvalidCharacter, &InvalidCharacter) => true,
            (&PrematureEnd, &PrematureEnd) => true,
            (&IoError(_), &IoError(_)) => true,
            (&EncodingError, &EncodingError) => true,
            _ => false,
        }
    }
}

impl Eq for DecodeErrKind {}

/// Error from decoding a entity-encoded string.
#[derive(Debug, Eq, PartialEq)]
pub struct DecodeErr {
    /// Number of characters read from the input before encountering an error
    pub position: usize,
    /// Type of error
    pub kind: DecodeErrKind,
}

#[derive(PartialEq, Eq)]
enum DecodeState {
    Normal,
    Entity,
    Named,
    Numeric,
    Hex,
    Dec,
}

macro_rules! try_parse(
    ($parse:expr, $pos:expr) => (
        match $parse {
            Err(reason) => return Err(DecodeErr{ position: $pos, kind: reason}),
            Ok(res) => res
        }
    ););

macro_rules! try_dec_io(
    ($io:expr, $pos:expr) => (
        match $io {
            Err(e) => return Err(DecodeErr{ position: $pos, kind: IoError(e)}),
            Ok(res) => res
        }
    ););

/// Decodes an entity-encoded string from a reader to a writer.
///
/// Similar to `decode_html`, except reading from a reader rather than a string, and
/// writing to a writer rather than returning a `String`.
///
/// # Arguments
/// - `reader` - UTF-8 encoded data is read from here.
/// - `writer` - UTF8- decoded data is written to here.
///
/// # Errors
/// Errors can be caused by IO errors, `reader` producing invalid UTF-8, or by syntax errors.
pub fn decode_html_rw<R: BufRead, W: Write>(
    reader: R,
    writer: &mut W,
    sloppy: bool,
) -> Result<(), DecodeErr> {
    let mut state: DecodeState = Normal;
    let mut good_pos = 0;
    let mut buf = String::with_capacity(8);

    for (pos, c) in io_support::chars(reader).enumerate() {
        let c = match c {
            Err(e) => {
                let kind = match e {
                    CharsError::NotUtf8 => EncodingError,
                    CharsError::Other(io) => IoError(io),
                };
                return Err(DecodeErr {
                    position: pos,
                    kind,
                });
            }
            Ok(c) => c,
        };
        match state {
            Normal if c == '&' => {
                buf.push(c);
                state = Entity
            }
            Normal => try_dec_io!(write_char(writer, c), good_pos),
            Entity if c == '#' => state = Numeric,
            Entity if c == ';' => {
                if sloppy {
                    buf.clear();
                } else {
                    return Err(DecodeErr {
                        position: good_pos,
                        kind: UnknownEntity,
                    });
                }
            }
            Entity => {
                state = Named;
                buf.push(c);
            }
            Named if c == ';' => {
                buf.push(c);
                state = Normal;

                match decode_named_entity(&buf) {
                    Err(reason) => {
                        if sloppy {
                            try_dec_io!(writer.write_all(buf.as_bytes()), good_pos);
                            buf.clear();
                        } else {
                            return Err(DecodeErr {
                                position: good_pos,
                                kind: reason,
                            });
                        }
                    }
                    Ok(res) => {
                        try_dec_io!(writer.write_all(res.as_bytes()), good_pos);
                        buf.clear();
                    }
                }
            }
            Named => buf.push(c),
            Numeric if is_digit(c) => {
                state = Dec;
                buf.push(c);
            }
            Numeric if c == 'x' => state = Hex,
            Dec if c == ';' => {
                state = Normal;
                let ch = try_parse!(
                    decode_numeric(&buf.get(1..).unwrap_or_default(), 10),
                    good_pos
                );
                try_dec_io!(write_char(writer, ch), good_pos);
                buf.clear();
            }
            Hex if c == ';' => {
                state = Normal;
                let ch = try_parse!(
                    decode_numeric(&buf.get(1..).unwrap_or_default(), 16),
                    good_pos
                );
                try_dec_io!(write_char(writer, ch), good_pos);
                buf.clear();
            }
            Hex if is_hex_digit(c) => buf.push(c),
            Dec if is_digit(c) => buf.push(c),
            Numeric | Hex | Dec => {
                if sloppy {
                    buf.clear();
                    state = Normal;
                } else {
                    return Err(DecodeErr {
                        position: good_pos,
                        kind: MalformedNumEscape,
                    });
                }
            }
        }

        if state == Normal {
            good_pos = pos + 1;
        }
    }

    if state != Normal && !sloppy {
        Err(DecodeErr {
            position: good_pos,
            kind: PrematureEnd,
        })
    } else {
        Ok(())
    }
}

/// Decodes an entity-encoded string.
///
/// Decodes an entity encoded string, replacing HTML entities (`&amp;`, `&#20;` ...) with the
/// the corresponding character. Case matters for named entities, ie. `&Amp;` is invalid.
/// Case does not matter for hex entities, so `&#x2E;` and `&#x2e;` are treated the same.
///
/// # Arguments
/// - `s` - Entity-encoded string to decode.
///
/// # Failure
/// The function will fail if input string contains invalid named entities (eg. `&nosuchentity;`),
/// invalid hex entities (eg. `&#xRT;`), invalid decimal entities (eg. `&#-1;), unclosed entities
/// (`s == "&amp hej och hå"`) or otherwise malformed entities.
///
/// This function will never return errors with `kind` set to `IoError` or `EncodingError`.
pub fn decode_html(s: &str) -> Result<String, DecodeErr> {
    decode_html_buf(s.as_bytes())
}

pub fn decode_html_sloppy(s: &str) -> Result<String, DecodeErr> {
    decode_html_buf_sloppy(s.as_bytes())
}

pub fn decode_html_buf(buf: impl AsRef<[u8]>) -> Result<String, DecodeErr> {
    let buf = buf.as_ref();
    let mut writer = Vec::with_capacity(buf.len());
    let mut reader = Cursor::new(buf);

    let res = decode_html_rw(&mut reader, &mut writer, false);
    match res {
        Ok(_) => Ok(String::from_utf8(writer).unwrap()),
        Err(err) => Err(err),
    }
}

pub fn decode_html_buf_sloppy(buf: impl AsRef<[u8]>) -> Result<String, DecodeErr> {
    let buf = buf.as_ref();
    let mut writer = Vec::with_capacity(buf.len());
    let mut reader = Cursor::new(buf);

    let res = decode_html_rw(&mut reader, &mut writer, true);
    match res {
        Ok(_) => Ok(String::from_utf8(writer).unwrap()),
        Err(err) => Err(err),
    }
}

fn is_digit(c: char) -> bool {
    c >= '0' && c <= '9'
}

fn is_hex_digit(c: char) -> bool {
    is_digit(c) || (c >= 'a' && c <= 'f') || (c >= 'A' && c <= 'F')
}

fn decode_named_entity(entity: &str) -> Result<&'static str, DecodeErrKind> {
    match entities::ENTITIES.iter().find(|e| e.entity == entity) {
        None => Err(UnknownEntity),
        Some(ref e) => Ok(e.characters),
    }
}

fn decode_numeric(esc: &str, radix: u32) -> Result<char, DecodeErrKind> {
    match u32::from_str_radix(esc, radix) {
        Ok(n) => match char::from_u32(n) {
            Some(c) => Ok(c),
            None => Err(InvalidCharacter),
        },
        Err(..) => Err(MalformedNumEscape),
    }
}

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

    // Regression test for "out of bounds" panic in sloppy decoder.
    #[test]
    fn test_decode_panic() {
        let bytes = b"&#1 ;foobar";
        let decoded = decode_html_buf_sloppy(bytes).unwrap();
        assert_eq!(decoded, ";foobar");
    }
}