bitjs/file/sniffer.js

/**
 * File Sniffer.
 * Makes an attempt to resolve a byte stream into a MIME type.
 *
 * Licensed under the MIT License
 *
 * Copyright(c) 2020 Google Inc.
 */

// https://mimesniff.spec.whatwg.org/ is a good resource.
// Easy targets for reverse-engineering:
// - https://github.com/h2non/filetype
// - https://github.com/gabriel-vasile/mimetype (particularly internal/magic/ftyp.go)

//  NOTE: Because the ICO format also starts with a couple zero bytes, this tree will rely on the
//        File Type box never going beyond 255 bytes in length which, seems unlikely according to
//        https://dev.to/alfg/a-quick-dive-into-mp4-57fo.
//  'ISO-BMFF': [[0x00, 0x00, 0x00, '??', 0x66, 0x74, 0x79, 0x70]], // box_length, then 'ftyp'
//  'MATROSKA': [[0x1A, 0x45, 0xDF, 0xA3]]

// A subset of "modern" formats from https://en.wikipedia.org/wiki/List_of_file_signatures.
// Mapping of MIME type to magic numbers.  Each file type can have multiple signatures.
// '??' is used as a placeholder value.
const fileSignatures = {
  // Document formats.
  'application/pdf': [[0x25, 0x50, 0x44, 0x46, 0x2d]], // '%PDF-'

  // Archive formats:
  'application/gzip': [[0x1F, 0x8B, 0x08]],
  'application/x-tar': [ // 'ustar'
    [0x75, 0x73, 0x74, 0x61, 0x72, 0x00, 0x30, 0x30],
    [0x75, 0x73, 0x74, 0x61, 0x72, 0x20, 0x20, 0x00],
  ],
  'application/x-7z-compressed': [[0x37, 0x7A, 0xBC, 0xAF, 0x27, 0x1C]], // '7z'
  'application/x-bzip2': [[0x42, 0x5A, 0x68]], // 'BZh'
  'application/x-rar-compressed': [[0x52, 0x61, 0x72, 0x21, 0x1A, 0x07]], // 'Rar!'
  'application/zip': [ // 'PK'
    [0x50, 0x4B, 0x03, 0x04],
    [0x50, 0x4B, 0x05, 0x06],
    [0x50, 0x4B, 0x07, 0x08],
  ],

  // Image formats.
  'image/bmp': [[0x42, 0x4D]], // 'BM'
  'image/gif': [[0x47, 0x49, 0x46, 0x38]], // 'GIF8'
  'image/jpeg': [[0xFF, 0xD8, 0xFF]],
  'image/png': [[0x89, 0x50, 0x4E, 0x47, 0x0D, 0x0A, 0x1A, 0x0A]],
  'image/webp': [[0x52, 0x49, 0x46, 0x46, '??', '??', '??', '??', 0x57, 0x45, 0x42, 0x50]], // 'RIFF....WEBP'
  'image/x-icon': [[0x00, 0x00, 0x01, 0x00]],

  // Audio/Video formats.
  'application/ogg': [[0x4F, 0x67, 0x67, 0x53]], // 'OggS'
  'audio/flac': [[0x66, 0x4C, 0x61, 0x43]], // 'fLaC'
  'audio/mpeg': [
    [0xFF, 0xFB],
    [0xFF, 0xF3],
    [0xFF, 0xF2],
    [0x49, 0x44, 0x33], // 'ID3'
  ],
  'audio/wav': [[0x52, 0x49, 0x46, 0x46, '??', '??', '??', '??', 0x57, 0x41, 0x56, 0x45]], // 'RIFF....WAVE'
  'video/avi': [[0x52, 0x49, 0x46, 0x46, '??', '??', '??', '??', 0x41, 0x56, 0x49, 0x20]], // 'RIFF....AVI '

  // Miscellaneous.
  'font/woff': [[0x77, 0x4F, 0x46, 0x46]], // 'wOFF'
  'font/woff2': [[0x77, 0x4F, 0x46, 0x32]], // 'wOF2'
};

/**
 * Represents a single byte in the magic number tree. If this node terminates a known MIME type
 * (see magic numbers above), then the mimeType field will be set.
 */
class Node {
  /** @type {string} */
  mimeType;

  /** @type {Object<number, Node>} */
  children = {};

  /** @param {number} value The byte that this Node points at. */
  constructor(value) {
    /** @type {number} */
    this.value = value;
  }
}

/** Top-level node in the byte tree. */
let root = null;
/** The maximum depth of the byte tree. */
let maxDepth = 0;

/**
 * This function initializes the byte tree. It is lazily called upon findMimeType(), but if you care
 * about when the tree initializes (like in startup, etc), you can call it yourself here.
 */
export function initialize() {
  root = new Node();

  // Construct the tree, erroring if overlapping mime types are found.
  for (const mimeType in fileSignatures) {
    for (const signature of fileSignatures[mimeType]) {
      let curNode = root;
      let depth = 0;
      for (const byte of signature) {
        if (curNode.children[byte] === undefined) {
          if (byte === '??' && !curNode.children['??'] && Object.keys(curNode.children).length > 0) {
            // Reset the byte tree, it is bogus.
            root = null;
            throw 'Cannot add a placeholder child to a node that has non-placeholder children';
          } else if (byte !== '??' && curNode.children['??']) {
            // Reset the byte tree, it is bogus.
            root = null;
            throw 'Cannot add a non-placeholder child to a node that has a placeholder child';
          }
          curNode.children[byte] = new Node(byte);
        }
        depth++;
        curNode = curNode.children[byte];
      } // for each byte

      if (maxDepth < depth) {
        maxDepth = depth;
      }

      if (curNode.mimeType) {
        throw `Magic number collision:  ${curNode.mimeType} overlaps with ${mimeType}`;
      } else if (Object.keys(curNode.children).length > 0) {
        throw `${mimeType} magic number is not unique, it collides with other mime types`;
      }
      curNode.mimeType = mimeType;
    } // for each signature
  }
}

/**
 * Finds the likely MIME type represented by the ArrayBuffer.
 * @param {ArrayBuffer} ab
 * @returns {string} The MIME type of the buffer, or undefined.
 */
export function findMimeType(ab) {
  if (!root) {
    initialize();
  }

  const arr = new Uint8Array(ab);
  let curNode = root;
  let mimeType;
  // Step through bytes, updating curNode as it walks down the byte tree.
  for (const byte of arr) {
    // If we found the mimeType or it is unknown, break the loop.
    if (!curNode || (mimeType = curNode.mimeType)) {
      break;
    }
    // Move into the next byte's node (if it exists) or the placeholder node (if it exists).
    curNode = curNode.children[byte] || curNode.children['??'];
  }
  return mimeType;
}