qt-json 1.0.2

//!
//! [![codecov](https://codecov.io/gh/TheDome/qt-json-rs/branch/develop/graph/badge.svg?token=7MIOMJ88B1)](https://codecov.io/gh/TheDome/qt-json-rs)
//! ![crates.io](https://img.shields.io/crates/v/qt-json.svg)
//!
//! A simple parser for the Internal Qt Binary JSON data format.
//!
//! This parser will transform the popular
//! [QTBinary JSON](https://doc.qt.io/qt-6.2/qbinaryjson.html#toBinaryData)
//! format into usable format for rust applications.
//!
//! # Use
//!
//! Simply provide a binary encoded JSON Array to the function and it will parse it into an
//! internal JSON structure:
//!
//! ```rust
//! use qt_json::QJSONDocument;
//!
//! fn main(){
//!         let json_data = b"qbjs\
//!     \x01\x00\x00\x00\
//!     \x10\x00\x00\x00\
//!     \x02\x00\x00\x00\
//!     \x0C\x00\x00\x00\
//!     \x4A\x01\x00\x00";
//!
//!     let document = QJSONDocument::from_binary(json_data.to_vec()).unwrap();
//!
//!     println!("{:?}", document);
//! }
//! ```
//!
//! # Disclaimer
//!
//! This library has been created by looking at the Qt source code and performing reverse
//! engineering.
//! There is a possibility that the code will not work with other Version of Qt JSON documents.
//! Any help with this library is welcome.

use std::collections::HashMap;
use std::io::{Cursor, Error, ErrorKind, Read};

use byteorder::ReadBytesExt;
use log::{debug, trace, warn};
use num_derive::FromPrimitive;
use num_traits::FromPrimitive;

use elements::{JsonBaseValue, JsonValue, Object};

pub mod elements;

/// A QJSONDocument is the root of every parsed JSOn Document.
/// It consists out of metadata and a base
#[derive(Debug)]
pub struct QJSONDocument {
    /// This will be "qbjs" encoded in an u32
    pub tag: u32,
    /// The QBJS Version. This needs to be 1
    pub version: u32,
    /// The Base element of the document.
    /// It muse either be an Array or an Object
    pub base: JsonBaseValue,
}

/// This is every possible value type in the QBJS format.
#[derive(Debug, Eq, PartialEq, FromPrimitive)]
#[repr(u32)]
enum QTValueType {
    /// A null value
    Null = 0x0,
    /// A boolean value
    Bool = 0x1,
    /// A signed integer value represented in the javascript number format (i.e. i64)
    Double = 0x2,
    /// A normal array of character. Can be latin or unicode
    String = 0x3,
    /// A JavaScript Array
    Array = 0x4,
    /// An JavaScript Object
    Object = 0x5,
    /// An explicitly undefined value
    Undefined = 0x80,
}

const QT_JSON_TAG: u32 =
    (('s' as u32) << 24) | (('j' as u32) << 16) | (('b' as u32) << 8) | ('q' as u32);

pub type Endianess = byteorder::LittleEndian;

impl QJSONDocument {
    /// Parses a binary VEC into a QJSONDocument
    pub fn from_binary(data: Vec<u8>) -> Result<Self, Error> {
        debug!("[QBJS] Loading data");

        let mut reader = Cursor::new(&data);

        let tag = reader.read_u32::<Endianess>()?;
        let version = reader.read_u32::<Endianess>()?;

        assert_eq!(tag, QT_JSON_TAG);

        assert_eq!(version, 1);

        debug!("QBJS Version: {}", version);

        let elem = Self::load_element(data[8..].to_vec())?;

        let base = match elem {
            JsonValue::Object(o) => JsonBaseValue::Object(o),
            JsonValue::Array(a) => JsonBaseValue::Array(a),
            _ => {
                return Err(Error::new(
                    ErrorKind::InvalidData,
                    "The Base must be either an Array or object",
                ));
            }
        };

        let doc = QJSONDocument { tag, version, base };

        debug!("[QBJS] Parsing finished!");

        Ok(doc)
    }

    /// Loads a single element from the binary data.
    fn load_element(data: Vec<u8>) -> Result<JsonValue, Error> {
        let mut reader = Cursor::new(&data);

        let size = reader.read_u32::<Endianess>()?;
        let header = reader.read_u32::<Endianess>()?;
        let offset = reader.read_u32::<Endianess>()?;

        let is_object = (header & 0x1) == 1;
        let len = header >> 1;

        trace!("Element Size is: {:#0X}", size);
        trace!("Element Offset is: {:#0X}", offset);
        trace!("Element is an object: {}", is_object);
        trace!("Element elements: {}", len);

        let table = data.split_at(offset as usize).1;

        // u32 is 4 bytes
        trace!("Table len is {}", table.len() / 4);

        let base = match is_object {
            true => Self::load_object(&data, table, len, size),
            false => Self::load_array(&data, table, len, size),
        };

        trace!("{:?}", base);

        base
    }

    /**
     * loads an object from the stream
     */
    fn load_object(data: &[u8], offsets: &[u8], len: u32, size: u32) -> Result<JsonValue, Error> {
        debug!("Loading object ..");
        trace!("Expected len: {}", len);
        trace!("Actual len: {}", offsets.len() / 4);

        if offsets.len() / 4 < (len as usize) {
            return Err(Error::new(
                ErrorKind::InvalidData,
                format!(
                    "The object is not the expected size, expected: {}, provided: {}",
                    len,
                    offsets.len() / 4
                ),
            ));
        }

        let mut offsets = Cursor::new(offsets);
        let mut values = HashMap::new();

        for i in 0..len {
            trace!("Iterating over entry {}", i);

            let offset = offsets.read_u32::<Endianess>()?;
            trace!("Entry at offset: {:0X?}", offset);

            let element = data.split_at(offset as usize).1;
            let mut reader = Cursor::new(element);

            let value_header = reader.read_u32::<Endianess>()?;
            trace!(" > Value header {:032b}", value_header);

            let value_type_number: u32 = value_header & 0b111;
            let latin_or_int = ((value_header & 0b1000) >> 3) == 1;
            let latin_key = ((value_header & 0b10000) >> 4) == 1;
            let orig_value: u32 = (value_header & 0xFFFFFFE0) >> 5;

            let value_type: Option<QTValueType> = FromPrimitive::from_u32(value_type_number);

            if value_type.is_none() {
                warn!("Could not parse value at json entry {}\nContinuing. But this might have unacceptable impact", i);
                debug!("Value type: {:#0X}", value_type_number);
                debug!("Value value: {:#04X}", orig_value);
            }

            trace!(" > Value of type: {:?}", value_type);
            trace!(" > Key is latin: {}", latin_key);
            let key = Self::read_string(&mut reader, latin_key)?;

            trace!(" > Key is: '{}'", key);
            trace!(" > Reading value of type: {:?}", value_type);

            let value = Self::decode_value(
                value_type,
                orig_value,
                latin_or_int,
                latin_key,
                size as usize,
                data,
            )?;

            trace!(" > Value is: {:?}", value);

            values.insert(key, value);
        }

        let object = Object { size: len, values };

        trace!("Using object {:?}", object);

        Ok(JsonValue::Object(object))
    }

    fn load_array(data: &[u8], offsets: &[u8], len: u32, size: u32) -> Result<JsonValue, Error> {
        debug!("Loading array ..");
        trace!("Expected len: {}", len);
        trace!("Actual len: {}", offsets.len() / 4);

        if offsets.len() / 4 < (len as usize) {
            return Err(Error::new(
                ErrorKind::InvalidData,
                format!(
                    "The array is not the expected size, expected: {}, provided: {}",
                    len,
                    offsets.len() / 4
                ),
            ));
        }

        let mut offsets = Cursor::new(offsets);
        let mut values = Vec::new();

        for i in 0..len {
            trace!("Iterating over entry {}", i);

            let offset = offsets.read_u32::<Endianess>()?;
            trace!("Entry at offset: 0x{:0X}", offset);

            let value_header = offset;
            trace!(" > Value header {:032b}b", value_header);

            let value_type_number: u16 = (value_header & 0b111) as u16;
            let latin_or_int = ((value_header & 0b1000) >> 3) == 1;
            let latin_key = ((value_header & 0b10000) >> 4) == 1;
            let orig_value: u32 = (value_header & 0xFFFFFFE0) >> 5;

            let value_type: Option<QTValueType> = FromPrimitive::from_u16(value_type_number);

            if value_type.is_none() {
                warn!("Could not parse value at json entry {}\nContinuing. But this might have unacceptable impact", i);
                debug!("Value type: {:#0X}", value_type_number);
                debug!("Value value: {:#04X}", orig_value);
            }

            trace!(" > Reading value of type: {:?}", value_type);

            let value = Self::decode_value(
                value_type,
                orig_value,
                latin_or_int,
                latin_key,
                size as usize,
                data,
            )?;

            trace!(" > Value is: {:?}", value);

            values.push(value);
        }

        Ok(JsonValue::Array(values))
    }

    /// This function is responsible from decoding a value from the given data.
    /// The value will be passed from the upper declaration function and will
    /// then be extracted here.
    ///
    /// This code has been created using reverse engineering. But it should work for QTJSONv1
    fn decode_value(
        value_type: Option<QTValueType>,
        orig_value: u32,
        latin_or_int: bool,
        latin_key: bool,
        size: usize,
        data: &[u8],
    ) -> Result<JsonValue, std::io::Error> {
        let value = match value_type {
            Some(QTValueType::Double) => {
                if latin_or_int {
                    JsonValue::Number(orig_value.into())
                } else {
                    trace!(" > > Value is of type f64");
                    trace!(" > > Value located at offset: {:0X?}", orig_value);

                    let value_data = data.split_at(orig_value as usize).1;
                    let mut reader = Cursor::new(value_data);
                    JsonValue::Number(reader.read_f64::<Endianess>()?)
                }
            }
            Some(QTValueType::String) => {
                trace!(" > > Value located at offset: {:0X?}", orig_value);

                let value_data = data.split_at(orig_value as usize).1;
                let mut reader = Cursor::new(value_data);
                JsonValue::String(Self::read_string(&mut reader, latin_key)?)
            }
            Some(QTValueType::Object) | Some(QTValueType::Array) => {
                trace!(" > > Value located at offset: {:0X?}", orig_value);

                trace!(
                    " > > Trimming {} bytes from object",
                    data.len() - size as usize
                );
                let value_data = data.split_at(size as usize).0;

                trace!(" > > Trimming {} bytes from object top", orig_value);
                let encapsulated = value_data.split_at(orig_value as usize).1;
                Self::load_element(Vec::from(encapsulated))?
            }
            Some(QTValueType::Bool) => JsonValue::Bool(orig_value != 0),
            Some(QTValueType::Null) => JsonValue::Null,
            _ => JsonValue::Undefined,
        };

        Ok(value)
    }

    /**
     * reads a string.
     * This class is capable of reading a string in UTF16 and UTF8
     */
    fn read_string(reader: &mut dyn Read, latin: bool) -> Result<String, Error> {
        let key_len = reader.read_u16::<Endianess>()?;

        trace!(" --> Reading string, latin:{}, len:{}", latin, key_len);
        // A latin string defined an ASCII encoded string array. So every character is 8 bits long.
        if latin {
            let mut buffer = Vec::new();
            for _ in 0..key_len {
                buffer.push(reader.read_u8()?);
            }

            Ok(String::from_utf8_lossy(buffer.as_slice()).parse().unwrap())
        } else {
            // By definition any string in JavaScript is UTF16 encoded else.
            let mut buffer = Vec::new();
            for _ in 0..key_len {
                buffer.push(reader.read_u16::<Endianess>()?);
            }
            String::from_utf16(buffer.as_slice())
                .map_err(|_| Error::new(ErrorKind::InvalidData, "Invalid UTF16"))
        }
    }
}

#[cfg(test)]
mod test {
    use crate::elements::{JsonBaseValue, JsonValue};
    use crate::QJSONDocument;

    #[test]
    fn read_object() {
        let object_str = b"qbjs\x01\x00\x00\x00$\x00\x00\x00\x03\x00\x00\x00 \
        \x00\x00\x00\x1B\x03\x00\x00\x04\x00test\x00\x00\x03\x00yes\x00\x00\x00\x0C\x00\x00\x00";

        let parsed = QJSONDocument::from_binary(object_str.to_vec()).unwrap();

        let val = match parsed.base {
            JsonBaseValue::Object(ref object) => {
                assert_eq!(object.size, 1);

                object.values.get("test").unwrap()
            }
            _ => panic!("Expected object"),
        };

        match val {
            JsonValue::String(ref s) => assert_eq!(s, "yes"),
            _ => panic!("Expected string"),
        }
    }

    #[test]
    fn test_non_latin_number() {
        let data = b"qbjs\x01\x00\x00\x00\x18\x00\x00\x00\x02\x00\x00\x00\x14\x00\x00\x00\
        \x33\x33\x33\x33\x33\x33\x24\x40\x82\x01\x00\x00";

        let parsed = QJSONDocument::from_binary(data.to_vec()).unwrap();

        match parsed.base {
            JsonBaseValue::Array(ref vals) => {
                assert_eq!(vals.len(), 1);
                let num = &vals[0];
                match num {
                    JsonValue::Number(n) => assert_eq!(*n, 10.1),
                    _ => panic!("Expected number"),
                }
            }
            _ => panic!("Expected array"),
        };
    }

    #[test]
    fn test_latin_string() {
        let data = b"qbjs\x01\x00\x00\x00\x14\x00\x00\x00\x02\x00\x00\x00\x10\x00\x00\x00\x01\x00\xF6\x00\x8B\x01\x00\x00";

        let parsed = QJSONDocument::from_binary(data.to_vec()).unwrap();

        match parsed.base {
            JsonBaseValue::Array(ref vals) => {
                assert_eq!(vals.len(), 1);
                let num = &vals[0];
                match num {
                    JsonValue::String(n) => assert_eq!(*n, "ö"),
                    _ => panic!("Expected string"),
                }
            }
            _ => panic!("Expected array"),
        };
    }

    #[test]
    fn test_bool() {
        let data = b"qbjs\x01\x00\x00\x00\x10\x00\x00\x00\x02\x00\x00\x00\x0C\x00\x00\x00!\x00\x00
        \x00";

        let parsed = QJSONDocument::from_binary(data.to_vec()).unwrap();

        match parsed.base {
            JsonBaseValue::Array(ref vals) => {
                assert_eq!(vals.len(), 1);
                let num = &vals[0];
                match num {
                    JsonValue::Bool(n) => assert_eq!(*n, true),
                    _ => panic!("Expected string"),
                }
            }
            _ => panic!("Expected array"),
        };
    }

    #[test]
    fn test_nested_object() {
        let data = b"qbjs\x01\x00\x00\x00\x34\x00\x00\x00\x02\x00\x00\x00\x30\x00\x00\x00\x24\x00\
                \x00\x00\x03\x00\x00\x00\x20\x00\x00\x00\x1B\x03\x00\x00\x04\x00test\x00\x00\x03\
                \x00yes\x00\x00\x00\x0C\x00\x00\x00\x85\x01\x00\x00";

        let parsed = QJSONDocument::from_binary(data.to_vec()).unwrap();

        match parsed.base {
            JsonBaseValue::Array(ref vals) => {
                assert_eq!(vals.len(), 1);
                let num = &vals[0];
                let val = match num {
                    JsonValue::Object(n) => {
                        assert_eq!(n.size, 1);
                        n.values.get("test").unwrap()
                    }
                    _ => panic!("Expected string"),
                };

                match val {
                    JsonValue::String(n) => assert_eq!(*n, "yes"),
                    _ => panic!("Expected string"),
                }
            }
            _ => panic!("Expected array"),
        };
    }
}