Example: The input "foo=bar&foo=baz&thinger=%20spaces%20=blah&zonk=blarg&" * Produces the output object: *
{
* foo: [ "bar", "baz" ],
* thinger: " spaces =blah",
* zonk: "blarg"
* }
*
* Note that spaces and other urlencoded entities are correctly handled * @see dojo.queryToObject() * While dojo.queryToObject() is mainly for URL query strings, this version * allows to specify a separator character */ exports.queryToObject = function(str, seperator) { var ret = {}; var qp = str.split(seperator || "&"); var dec = decodeURIComponent; qp.forEach(function(item) { if (item.length) { var parts = item.split("="); var name = dec(parts.shift()); var val = dec(parts.join("=")); if (exports.isString(ret[name])){ ret[name] = [ret[name]]; } if (Array.isArray(ret[name])){ ret[name].push(val); } else { ret[name] = val; } } }); return ret; }; /** * Takes a name/value mapping object and returns a string representing a * URL-encoded version of that object for use in a GET request *
For example, given the input:
* { blah: "blah", multi: [ "thud", "thonk" ] }
* The following string would be returned:
* "blah=blah&multi=thud&multi=thonk"
* @param map {Object} The object to convert
* @return {string} A URL-encoded version of the input
*/
exports.objectToQuery = function(map) {
// FIXME: need to implement encodeAscii!!
var enc = encodeURIComponent;
var pairs = [];
var backstop = {};
for (var name in map) {
var value = map[name];
if (value != backstop[name]) {
var assign = enc(name) + "=";
if (value.isArray) {
for (var i = 0; i < value.length; i++) {
pairs.push(assign + enc(value[i]));
}
} else {
pairs.push(assign + enc(value));
}
}
}
return pairs.join("&");
};
/**
* Holds the count to keep a unique value for setTimeout
* @private See rateLimit()
*/
var nextRateLimitId = 0;
/**
* Holds the timeouts so they can be cleared later
* @private See rateLimit()
*/
var rateLimitTimeouts = {};
/**
* Delay calling some function to check that it's not called again inside a
* maxRate. The real function is called after maxRate ms unless the return
* value of this function is called before, in which case the clock is restarted
*/
exports.rateLimit = function(maxRate, scope, func) {
if (maxRate) {
var rateLimitId = nextRateLimitId++;
return function() {
if (rateLimitTimeouts[rateLimitId]) {
clearTimeout(rateLimitTimeouts[rateLimitId]);
}
rateLimitTimeouts[rateLimitId] = setTimeout(function() {
func.apply(scope, arguments);
delete rateLimitTimeouts[rateLimitId];
}, maxRate);
};
}
};
/**
* Return true if it is a String
*/
exports.isString = function(it) {
return (typeof it == "string" || it instanceof String);
};
/**
* Returns true if it is a Boolean.
*/
exports.isBoolean = function(it) {
return (typeof it == 'boolean');
};
/**
* Returns true if it is a Number.
*/
exports.isNumber = function(it) {
return (typeof it == 'number' && isFinite(it));
};
/**
* Hack copied from dojo.
*/
exports.isObject = function(it) {
return it !== undefined &&
(it === null || typeof it == "object" ||
Array.isArray(it) || exports.isFunction(it));
};
/**
* Is the passed object a function?
* From dojo.isFunction()
*/
exports.isFunction = (function() {
var _isFunction = function(it) {
var t = typeof it; // must evaluate separately due to bizarre Opera bug. See #8937
//Firefox thinks object HTML element is a function, so test for nodeType.
return it && (t == "function" || it instanceof Function) && !it.nodeType; // Boolean
};
return exports.isSafari ?
// only slow this down w/ gratuitious casting in Safari (not WebKit)
function(/*anything*/ it) {
if (typeof it == "function" && it == "[object NodeList]") {
return false;
}
return _isFunction(it); // Boolean
} : _isFunction;
})();
/**
* A la Prototype endsWith(). Takes a regex excluding the '$' end marker
*/
exports.endsWith = function(str, end) {
if (!str) {
return false;
}
return str.match(new RegExp(end + "$"));
};
/**
* A la Prototype include().
*/
exports.include = function(array, item) {
return array.indexOf(item) > -1;
};
/**
* Like include, but useful when you're checking for a specific
* property on each object in the list...
*
* Returns null if the item is not in the list, otherwise
* returns the index of the item.
*/
exports.indexOfProperty = function(array, propertyName, item) {
for (var i = 0; i < array.length; i++) {
if (array[i][propertyName] == item) {
return i;
}
}
return null;
};
/**
* A la Prototype last().
*/
exports.last = function(array) {
if (Array.isArray(array)) {
return array[array.length - 1];
}
};
/**
* Knock off any undefined items from the end of an array
*/
exports.shrinkArray = function(array) {
var newArray = [];
var stillAtBeginning = true;
array.reverse().forEach(function(item) {
if (stillAtBeginning && item === undefined) {
return;
}
stillAtBeginning = false;
newArray.push(item);
});
return newArray.reverse();
};
/**
* Create an array
* @param number The size of the new array to create
* @param character The item to put in the array, defaults to ' '
*/
exports.makeArray = function(number, character) {
if (number < 1) {
return []; // give us a normal number please!
}
if (!character){character = ' ';}
var newArray = [];
for (var i = 0; i < number; i++) {
newArray.push(character);
}
return newArray;
};
/**
* Repeat a string a given number of times.
* @param string String to repeat
* @param repeat Number of times to repeat
*/
exports.repeatString = function(string, repeat) {
var newstring = '';
for (var i = 0; i < repeat; i++) {
newstring += string;
}
return newstring;
};
/**
* Given a row, find the number of leading spaces.
* E.g. an array with the string " aposjd" would return 2
* @param row The row to hunt through
*/
exports.leadingSpaces = function(row) {
var numspaces = 0;
for (var i = 0; i < row.length; i++) {
if (row[i] == ' ' || row[i] == '' || row[i] === undefined) {
numspaces++;
} else {
return numspaces;
}
}
return numspaces;
};
/**
* Given a row, find the number of leading tabs.
* E.g. an array with the string " aposjd" would return 2
* @param row The row to hunt through
*/
exports.leadingTabs = function(row) {
var numtabs = 0;
for (var i = 0; i < row.length; i++) {
if (row[i] == ' ' || row[i] == '' || row[i] === undefined) {
numtabs++;
} else {
return numtabs;
}
}
return numtabs;
};
/**
* Given a row, extract a copy of the leading spaces or tabs.
* E.g. an array with the string " aposjd" would return an array with the
* string " ".
* @param row The row to hunt through
*/
exports.leadingWhitespace = function(row) {
var leading = [];
for (var i = 0; i < row.length; i++) {
if (row[i] == ' ' || row[i] == ' ' || row[i] == '' || row[i] === undefined) {
leading.push(row[i]);
} else {
return leading;
}
}
return leading;
};
/**
* Given a camelCaseWord convert to "Camel Case Word"
*/
exports.englishFromCamel = function(camel) {
camel.replace(/([A-Z])/g, function(str) {
return " " + str.toLowerCase();
}).trim();
};
/**
* I hate doing this, but we need some way to determine if the user is on a Mac
* The reason is that users have different expectations of their key combinations.
*
* Take copy as an example, Mac people expect to use CMD or APPLE + C
* Windows folks expect to use CTRL + C
*/
exports.OS = {
LINUX: 'LINUX',
MAC: 'MAC',
WINDOWS: 'WINDOWS'
};
var ua = navigator.userAgent;
var av = navigator.appVersion;
/** Is the user using a browser that identifies itself as Linux */
exports.isLinux = av.indexOf("Linux") >= 0;
/** Is the user using a browser that identifies itself as Windows */
exports.isWindows = av.indexOf("Win") >= 0;
/** Is the user using a browser that identifies itself as WebKit */
exports.isWebKit = parseFloat(ua.split("WebKit/")[1]) || undefined;
/** Is the user using a browser that identifies itself as Chrome */
exports.isChrome = parseFloat(ua.split("Chrome/")[1]) || undefined;
/** Is the user using a browser that identifies itself as Mac OS */
exports.isMac = av.indexOf("Macintosh") >= 0;
/* Is this Firefox or related? */
exports.isMozilla = av.indexOf('Gecko/') >= 0;
if (ua.indexOf("AdobeAIR") >= 0) {
exports.isAIR = 1;
}
/**
* Is the user using a browser that identifies itself as Safari
* See also:
* - http://developer.apple.com/internet/safari/faq.html#anchor2
* - http://developer.apple.com/internet/safari/uamatrix.html
*/
var index = Math.max(av.indexOf("WebKit"), av.indexOf("Safari"), 0);
if (index && !exports.isChrome) {
// try to grab the explicit Safari version first. If we don't get
// one, look for less than 419.3 as the indication that we're on something
// "Safari 2-ish".
exports.isSafari = parseFloat(av.split("Version/")[1]);
if (!exports.isSafari || parseFloat(av.substr(index + 7)) <= 419.3) {
exports.isSafari = 2;
}
}
if (ua.indexOf("Gecko") >= 0 && !exports.isWebKit) {
exports.isMozilla = parseFloat(av);
}
/**
* Return a exports.OS constant
*/
exports.getOS = function() {
if (exports.isMac) {
return exports.OS['MAC'];
} else if (exports.isLinux) {
return exports.OS['LINUX'];
} else {
return exports.OS['WINDOWS'];
}
};
/** Returns true if the DOM element "b" is inside the element "a". */
if (typeof(document) !== 'undefined' && document.compareDocumentPosition) {
exports.contains = function(a, b) {
return a.compareDocumentPosition(b) & 16;
};
} else {
exports.contains = function(a, b) {
return a !== b && (a.contains ? a.contains(b) : true);
};
}
/**
* Prevents propagation and clobbers the default action of the passed event
*/
exports.stopEvent = function(ev) {
ev.preventDefault();
ev.stopPropagation();
};
/**
* Create a random password of the given length (default 16 chars)
*/
exports.randomPassword = function(length) {
length = length || 16;
var chars = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890";
var pass = "";
for (var x = 0; x < length; x++) {
var charIndex = Math.floor(Math.random() * chars.length);
pass += chars.charAt(charIndex);
}
return pass;
};
/**
* Is the passed object free of members, i.e. are there any enumerable
* properties which the objects claims as it's own using hasOwnProperty()
*/
exports.isEmpty = function(object) {
for (var x in object) {
if (object.hasOwnProperty(x)) {
return false;
}
}
return true;
};
/**
* Does the name of a project indicate that it is owned by someone else
* TODO: This is a major hack. We really should have a File object that include
* separate owner information.
*/
exports.isMyProject = function(project) {
return project.indexOf("+") == -1;
};
/**
* Format a date as dd MMM yyyy
*/
exports.formatDate = function (date) {
if (!date) {
return "Unknown";
}
return date.getDate() + " " +
exports.formatDate.shortMonths[date.getMonth()] + " " +
date.getFullYear();
};
/**
* Month data for exports.formatDate
*/
exports.formatDate.shortMonths = [ "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" ];
/**
* Add a CSS class to the list of classes on the given node
*/
exports.addClass = function(node, className) {
var parts = className.split(/\s+/);
var cls = " " + node.className + " ";
for (var i = 0, len = parts.length, c; i < len; ++i) {
c = parts[i];
if (c && cls.indexOf(" " + c + " ") < 0) {
cls += c + " ";
}
}
node.className = cls.trim();
};
/**
* Remove a CSS class from the list of classes on the given node
*/
exports.removeClass = function(node, className) {
var cls;
if (className !== undefined) {
var parts = className.split(/\s+/);
cls = " " + node.className + " ";
for (var i = 0, len = parts.length; i < len; ++i) {
cls = cls.replace(" " + parts[i] + " ", " ");
}
cls = cls.trim();
} else {
cls = "";
}
if (node.className != cls) {
node.className = cls;
}
};
/**
* Add or remove a CSS class from the list of classes on the given node
* depending on the value of include
*/
exports.setClass = function(node, className, include) {
if (include) {
exports.addClass(node, className);
} else {
exports.removeClass(node, className);
}
};
/**
* Is the passed object either null or undefined (using ===)
*/
exports.none = function(obj) {
return obj === null || obj === undefined;
};
/**
* Creates a clone of the passed object. This function can take just about
* any type of object and create a clone of it, including primitive values
* (which are not actually cloned because they are immutable).
* If the passed object implements the clone() method, then this function
* will simply call that method and return the result.
*
* @param object {Object} the object to clone
* @param deep {Boolean} do a deep clone?
* @returns {Object} the cloned object
*/
exports.clone = function(object, deep) {
if (Array.isArray(object) && !deep) {
return object.slice();
}
if (typeof object === 'object' || Array.isArray(object)) {
if (object === null) {
return null;
}
var reply = (Array.isArray(object) ? [] : {});
for (var key in object) {
if (deep && (typeof object[key] === 'object'
|| Array.isArray(object[key]))) {
reply[key] = exports.clone(object[key], true);
} else {
reply[key] = object[key];
}
}
return reply;
}
if (object && typeof(object.clone) === 'function') {
return object.clone();
}
// That leaves numbers, booleans, undefined. Doesn't it?
return object;
};
/**
* Helper method for extending one object with another
* Copies all properties from source to target. Returns the extended target
* object.
* Taken from John Resig, http://ejohn.org/blog/javascript-getters-and-setters/.
*/
exports.mixin = function(a, b) {
for (var i in b) {
var g = b.__lookupGetter__(i);
var s = b.__lookupSetter__(i);
if (g || s) {
if (g) {
a.__defineGetter__(i, g);
}
if (s) {
a.__defineSetter__(i, s);
}
} else {
a[i] = b[i];
}
}
return a;
};
/**
* Basically taken from Sproutcore.
* Replaces the count items from idx with objects.
*/
exports.replace = function(arr, idx, amt, objects) {
return arr.slice(0, idx).concat(objects).concat(arr.slice(idx + amt));
};
/**
* Return true if the two frames match. You can also pass only points or sizes.
* @param r1 {Rect} the first rect
* @param r2 {Rect} the second rect
* @param delta {Float} an optional delta that allows for rects that do not match exactly. Defaults to 0.1
* @returns {Boolean} true if rects match
*/
exports.rectsEqual = function(r1, r2, delta) {
if (!r1 || !r2) {
return r1 == r2;
}
if (!delta && delta !== 0) {
delta = 0.1;
}
if ((r1.y != r2.y) && (Math.abs(r1.y - r2.y) > delta)) {
return false;
}
if ((r1.x != r2.x) && (Math.abs(r1.x - r2.x) > delta)) {
return false;
}
if ((r1.width != r2.width) && (Math.abs(r1.width - r2.width) > delta)) {
return false;
}
if ((r1.height != r2.height) && (Math.abs(r1.height - r2.height) > delta)) {
return false;
}
return true;
};
});