VulpesOS/gaia/shared/js/text_normalizer.js

/* -*- Mode: Java; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- /
/* vim: set shiftwidth=2 tabstop=2 autoindent cindent expandtab: */

'use strict';

/**
 * text_normalizer.js: a basic string normalizer library that provides various
 *                     methods to normalize strings of characters
 *
 * The following methods are available:
 *    toAscii(string): convert strings containing accented-form characters to
 *                     their ASCII equivalent
 *
 *    escapeHTML(string, boolean): escape HTML tags
 *    escapeRegExp(string): escape regular expressions
 */
var Normalizer = {
  /**
   * Initialize the ASCII normalizer
   */
  initAsciiNormalizer: function normalizer_init() {
    // Map from lowercase ASCII to all known accented forms of the letter
    var equivalentChars = {
      'a': 'áăǎâäȧạȁàảȃāąåḁⱥãǽǣæ',
      'A': 'ÁĂǍÂÄȦẠȀÀẢȂĀĄÅḀȺÃǼǢÆ',
      'b': 'ḃḅɓḇƀƃ',
      'B': 'ḂḄƁḆɃƂ',
      'c': 'ćčçĉċƈȼ',
      'C': 'ĆČÇĈĊƇȻ',
      'd': 'ďḑḓḋḍɗḏđƌð',
      'D': 'ĎḐḒḊḌƊḎĐƋ',
      'e': 'éĕěȩêḙëėẹȅèẻȇēę',
      'E': 'ÉĔĚȨÊḘËĖẸȄÈẺȆĒĘ',
      'f': 'ḟƒ',
      'F': 'ḞƑ',
      'g': 'ǵğǧģĝġɠḡǥ',
      'G': 'ǴĞǦĢĜĠƓḠǤ',
      'h': 'ḫȟḩĥⱨḧḣḥħ',
      'H': 'ḪȞḨĤⱧḦḢḤĦ',
      'i': 'íĭǐîïịȉìỉȋīįɨĩḭı',
      'I': 'ÍĬǏÎÏỊȈÌỈȊĪĮƗĨḬ',
      'j': 'ĵɉ',
      'J': 'ĴɈ',
      'k': 'ḱǩķⱪꝃḳƙḵꝁ',
      'K': 'ḰǨĶⱩꝂḲƘḴꝀ',
      'l': 'ĺƚľļḽḷⱡꝉḻŀɫł',
      'L': 'ĹȽĽĻḼḶⱠꝈḺĿⱢŁ',
      'm': 'ḿṁṃɱ',
      'M': 'ḾṀṂⱮ',
      'n': 'ńňņṋṅṇǹɲṉƞñ',
      'N': 'ŃŇŅṊṄṆǸƝṈȠÑ',
      'o': 'óŏǒôöȯọőȍòỏơȏꝋꝍōǫøõœ',
      'O': 'ÓŎǑÔÖȮỌŐȌÒỎƠȎꝊꝌŌǪØÕŒ',
      'p': 'ṕṗꝓƥᵽꝑ',
      'P': 'ṔṖꝒƤⱣꝐ',
      'q': 'ꝗ',
      'Q': 'Ꝗ',
      'r': 'ŕřŗṙṛȑȓṟɍɽ',
      'R': 'ŔŘŖṘṚȐȒṞɌⱤ',
      's': 'śšşŝșṡṣß',
      'S': 'ŚŠŞŜȘṠṢ',
      't': 'ťţṱțⱦṫṭƭṯʈŧ',
      'T': 'ŤŢṰȚȾṪṬƬṮƮŦ',
      'u': 'úŭǔûṷüṳụűȕùủưȗūųůũṵ',
      'U': 'ÚŬǓÛṶÜṲỤŰȔÙỦƯȖŪŲŮŨṴ',
      'v': 'ṿʋṽ',
      'V': 'ṾƲṼ',
      'w': 'ẃŵẅẇẉẁⱳ',
      'W': 'ẂŴẄẆẈẀⱲ',
      'x': 'ẍẋ',
      'X': 'ẌẊ',
      'y': 'ýŷÿẏỵỳƴỷỿȳɏỹ',
      'Y': 'ÝŶŸẎỴỲƳỶỾȲɎỸ',
      'z': 'źžẑⱬżẓȥẕƶ',
      'Z': 'ŹŽẐⱫŻẒȤẔƵ'
    };
    // Create the reverse map (i.e. the accented chars to their ASCII
    // equivalent) and build the regexp string
    this._toAsciiForm = {};
    for (var letter in equivalentChars) {
      var accentedForms = equivalentChars[letter];
      for (var i = accentedForms.length - 1; i >= 0; i--) {
        this._toAsciiForm[accentedForms[i]] = letter;
      }
    }
  },

  /**
   * Convert a string of characters to its ASCII equivalent
   * @param {string} str a string of characters.
   * @return {string} the normalized (ASCII) string in lower case.
   */
  toAscii: function normalizer_toAscii(str) {
    if (!str || typeof str != 'string') {
      return '';
    }

    if (!this._toAsciiForm) {
      Normalizer.initAsciiNormalizer();
    }

    // Convert accented form to ASCII equivalent
    var result = '';
    for (var i = 0, len = str.length; i < len; i++) {
      result += this._toAsciiForm[str.charAt(i)] || str.charAt(i);
    }

    return result;
  },

  /**
   * Escape HTML tags in a string of characters
   * @param {string} str a string of characters.
   * @param {boolean} escapeQuotes (optional) escape quotes.
   * @return {string} the HTML-escaped string.
   */
  escapeHTML: function normalizer_escapeHTML(str, escapeQuotes) {
    if (Array.isArray(str)) {
      return Normalizer.escapeHTML(str.join(' '), escapeQuotes);
    }

    if (!str || typeof str != 'string') {
      return '';
    }

    var escaped = str.replace(/&/g, '&amp;').replace(/</g, '&lt;')
                     .replace(/>/g, '&gt;');
    if (escapeQuotes) {
      return escaped.replace(/"/g, '&quot;').replace(/'/g, '&#x27;');
    }
    return escaped;
  },

  unescapeHTML: function normalizer_unescapeHTML(text) {
    return text.replace(/&amp;/g, '&')
      .replace(/&lt;/g, '<')
      .replace(/&gt;/g, '>')
      .replace(/&quot;/g, '"')
      .replace(/&#x27;/g, '\'');
  },

  /**
   * Escape regular expressions in a string of characters
   * @param {string} str a string of characters.
   * @return {string} the regexp-escaped string.
   */
  escapeRegExp: function normalizer_escapeRegExp(str) {
    return str.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, '\\$&');
  }
};