util.js

  1. /**
  2.  * @namespace concrete
  3.  */
  4. var concrete = concrete || {};
  6. /**
  7.  * @namespace concrete.util
  8.  */
  9. concrete.util = (function() {
  10.   var util = {};
  12.   /**
  13.    * Generate a Concrete UUID
  14.    *
  15.    * @returns {UUID}
  16.    *
  17.    * @function concrete.util.generateUUID
  18.    * @memberof concrete.util
  19.    */
  20.   util.generateUUID = function() {
  21.     var uuid = new UUID();
  22.     uuid.uuidString = util.generateUUIDString();
  23.     return uuid;
  24.   };
  26.   /**
  27.    * Generate a UUID string
  28.    * Code based on the uuid.core.js script from MIT licensed project 'UUID.js':
  29.    *    https://github.com/LiosK/UUID.js
  30.    *
  31.    * @returns {String}
  32.    *
  33.    * @function concrete.util.generateUUIDString
  34.    * @memberof concrete.util
  35.    */
  36.   util.generateUUIDString = function() {
  37.     /**
  38.      * Returns an unsigned x-bit random integer.
  39.      * @param {int} x A positive integer ranging from 0 to 53, inclusive.
  40.      * @returns {int} An unsigned x-bit random integer (0 <= f(x) < 2^x).
  41.      */
  42.     function rand(x) {  // _getRandomInt
  43.       if (x <   0) return NaN;
  44.       if (x <= 30) return (0 | Math.random() * (1 <<      x));
  45.       if (x <= 53) return (0 | Math.random() * (1 <<     30)) +
  46.         (0 | Math.random() * (1 << x - 30)) * (1 << 30);
  47.       return NaN;
  48.     }
  50.     /**
  51.      * Converts an integer to a zero-filled hexadecimal string.
  52.      * @param {int} num
  53.      * @param {int} length
  54.      * @returns {string}
  55.      */
  56.     function hex(num, length) { // _hexAligner
  57.       var str = num.toString(16), i = length - str.length, z = "0";
  58.       for (; i > 0; i >>>= 1, z += z) { if (i & 1) { str = z + str; } }
  59.       return str;
  60.     }
  62.     return  hex(rand(32), 8) +    // time_low
  63.       "-" +
  64.       hex(rand(16), 4) +          // time_mid
  65.       "-" +
  66.       hex(0x4000 | rand(12), 4) + // time_hi_and_version
  67.       "-" +
  68.       hex(0x8000 | rand(14), 4) + // clock_seq_hi_and_reserved clock_seq_low
  69.       "-" +
  70.       hex(rand(48), 12);        // node
  71.   };
  73.   /** Retrieve HTTP GET parameters by name
  74.    *
  75.    * Adapted from:
  76.    *   http://stackoverflow.com/questions/19491336/get-url-parameter-jquery-or-how-to-get-query-string-values-in-js
  77.    *
  78.    * @param {String} sParam - Name of HTTP GET parameter to retrieve
  79.    * @returns {String}
  80.    *
  81.    * @function concrete.util.getURLParameter
  82.    * @memberof concrete.util
  83.    */
  84.   util.getURLParameter = function(sParam) {
  85.     var sPageURL = decodeURIComponent(window.location.search.substring(1)),
  86.         sURLVariables = sPageURL.split('&'),
  87.         sParameterName,
  88.         i;
  90.     for (i = 0; i < sURLVariables.length; i++) {
  91.       sParameterName = sURLVariables[i].split('=');
  93.       if (sParameterName[0] === sParam) {
  94.         return sParameterName[1] === undefined ? true : sParameterName[1];
  95.       }
  96.     }
  97.   };
  100.   /**
  101.    * Takes a string, returns a version of the string that replaces
  102.    * any of the CSS selector metacharacters:
  103.    *   !"#$%&'()*+,./:;<=>?@[\]^`{|}~
  104.    * with an underscore.  Per the jQuery documentation, these
  105.    * metacharacters in CSS selector names if they are escaped with '\\',
  106.    * but replacing them with underscores seems less likely to cause
  107.    * strange behavior.
  108.    *
  109.    * Useful for handling Entity IDs that are prefixed with a colon,
  110.    * e.g. ':Entity_ENG_EDL_0088070'.
  111.    *
  112.    * @param {String} s
  113.    * @returns {String}
  114.    */
  115.   util.selectorSafeString = function(s) {
  116.     return s.replace(/[!"#$%&'()*+,./:;<=>?@[\]^`{|}~]/g, '_');
  117.   };
  120.   return util;
  121. })();