Improve output: distinguish between failed assertions (failures) and unexpected exceptions (errors), and print a filtered stack trace for any exception.

This commit is contained in:
jeb228 2010-01-29 22:13:57 +00:00
commit 4f2e303079
1839 changed files with 235630 additions and 0 deletions

View file

@ -0,0 +1,82 @@
/*
Copyright (c) 2004-2006, The Dojo Foundation
All Rights Reserved.
Licensed under the Academic Free License version 2.1 or above OR the
modified BSD license. For more information on Dojo licensing, see:
http://dojotoolkit.org/community/licensing.shtml
*/
dojo.provide("dojo.uuid.LightweightGenerator");
/**
* The LightweightGenerator is intended to be small and fast,
* but not necessarily good.
*
* Small: The LightweightGenerator has a small footprint.
* Once comments are stripped, it's only about 25 lines of
* code, and it doesn't dojo.require() any other packages.
*
* Fast: The LightweightGenerator can generate lots of new
* UUIDs fairly quickly (at least, more quickly than the other
* dojo UUID generators).
*
* Not necessarily good: We use Math.random() as our source
* of randomness, which may or may not provide much randomness.
*/
dojo.uuid.LightweightGenerator = new function() {
var HEX_RADIX = 16;
// --------------------------------------------------
// Private functions
// --------------------------------------------------
function _generateRandomEightCharacterHexString() {
// Make random32bitNumber be a randomly generated floating point number
// between 0 and (4,294,967,296 - 1), inclusive.
var random32bitNumber = Math.floor( (Math.random() % 1) * Math.pow(2, 32) );
var eightCharacterHexString = random32bitNumber.toString(HEX_RADIX);
while (eightCharacterHexString.length < 8) {
eightCharacterHexString = "0" + eightCharacterHexString;
}
return eightCharacterHexString; // for example: "3B12F1DF"
}
// --------------------------------------------------
// Public functions
// --------------------------------------------------
/**
* This function generates random UUIDs, meaning "version 4" UUIDs.
* For example, a typical generated value would be something like
* "3b12f1df-5232-4804-897e-917bf397618a".
*
* Examples:
* <pre>
* var string = dojo.uuid.LightweightGenerator.generate();
* var string = dojo.uuid.LightweightGenerator.generate(String);
* var uuid = dojo.uuid.LightweightGenerator.generate(dojo.uuid.Uuid);
* </pre>
*
* @param returnType Optional. The type of instance to return.
* @return A newly generated version 4 UUID.
*/
this.generate = function(returnType) {
var hyphen = "-";
var versionCodeForRandomlyGeneratedUuids = "4"; // 8 == binary2hex("0100")
var variantCodeForDCEUuids = "8"; // 8 == binary2hex("1000")
var a = _generateRandomEightCharacterHexString();
var b = _generateRandomEightCharacterHexString();
b = b.substring(0, 4) + hyphen + versionCodeForRandomlyGeneratedUuids + b.substring(5, 8);
var c = _generateRandomEightCharacterHexString();
c = variantCodeForDCEUuids + c.substring(1, 4) + hyphen + c.substring(4, 8);
var d = _generateRandomEightCharacterHexString();
var returnValue = a + hyphen + b + hyphen + c + d;
returnValue = returnValue.toLowerCase();
if (returnType && (returnType != String)) {
returnValue = new returnType(returnValue);
}
return returnValue;
};
}();

View file

@ -0,0 +1,43 @@
/*
Copyright (c) 2004-2006, The Dojo Foundation
All Rights Reserved.
Licensed under the Academic Free License version 2.1 or above OR the
modified BSD license. For more information on Dojo licensing, see:
http://dojotoolkit.org/community/licensing.shtml
*/
dojo.provide("dojo.uuid.NameBasedGenerator");
dojo.uuid.NameBasedGenerator = new function() {
/**
* This function generates name-based UUIDs, meaning "version 3"
* and "version 5" UUIDs.
*
* Examples:
* <pre>
* var string = dojo.uuid.NameBasedGenerator.generate();
* var string = dojo.uuid.NameBasedGenerator.generate(String);
* var uuid = dojo.uuid.NameBasedGenerator.generate(dojo.uuid.Uuid);
* </pre>
*
* @param returnType Optional. The type of instance to return.
* @return A newly generated version 3 or version 5 UUID.
*/
this.generate = function(returnType) {
dojo.unimplemented('dojo.uuid.NameBasedGenerator.generate');
// FIXME:
// For an algorithm to generate name-based UUIDs,
// see sections 4.3 of RFC 4122:
// http://www.ietf.org/rfc/rfc4122.txt
var returnValue = "00000000-0000-0000-0000-000000000000"; // FIXME
if (returnType && (returnType != String)) {
returnValue = new returnType(returnValue);
}
return returnValue;
};
}();

View file

@ -0,0 +1,38 @@
/*
Copyright (c) 2004-2006, The Dojo Foundation
All Rights Reserved.
Licensed under the Academic Free License version 2.1 or above OR the
modified BSD license. For more information on Dojo licensing, see:
http://dojotoolkit.org/community/licensing.shtml
*/
dojo.provide("dojo.uuid.NilGenerator");
dojo.uuid.NilGenerator = new function() {
/**
* This function returns the Nil UUID:
* "00000000-0000-0000-0000-000000000000".
* The Nil UUID is described in section 4.1.7 of
* RFC 4122: http://www.ietf.org/rfc/rfc4122.txt
*
* Examples:
* <pre>
* var string = dojo.uuid.NilGenerator.generate();
* var string = dojo.uuid.NilGenerator.generate(String);
* var uuid = dojo.uuid.NilGenerator.generate(dojo.uuid.Uuid);
* </pre>
*
* @param returnType Optional. The type of instance to return.
* @return The nil UUID.
*/
this.generate = function(returnType) {
var returnValue = "00000000-0000-0000-0000-000000000000";
if (returnType && (returnType != String)) {
returnValue = new returnType(returnValue);
}
return returnValue;
};
}();

View file

@ -0,0 +1,44 @@
/*
Copyright (c) 2004-2006, The Dojo Foundation
All Rights Reserved.
Licensed under the Academic Free License version 2.1 or above OR the
modified BSD license. For more information on Dojo licensing, see:
http://dojotoolkit.org/community/licensing.shtml
*/
dojo.provide("dojo.uuid.RandomGenerator");
dojo.uuid.RandomGenerator = new function() {
/**
* This function generates random UUIDs, meaning "version 4" UUIDs.
* For example, a typical generated value would be something like
* "3b12f1df-5232-4804-897e-917bf397618a".
*
* Examples:
* <pre>
* var string = dojo.uuid.RandomGenerator.generate();
* var string = dojo.uuid.RandomGenerator.generate(String);
* var uuid = dojo.uuid.RandomGenerator.generate(dojo.uuid.Uuid);
* </pre>
*
* @param returnType Optional. The type of instance to return.
* @return A newly generated version 4 UUID.
*/
this.generate = function(returnType) {
dojo.unimplemented('dojo.uuid.RandomGenerator.generate');
// FIXME:
// For an algorithm to generate a random UUID, see
// sections 4.4 and 4.5 of RFC 4122:
// http://www.ietf.org/rfc/rfc4122.txt
var returnValue = "00000000-0000-0000-0000-000000000000"; // FIXME
if (returnType && (returnType != String)) {
returnValue = new returnType(returnValue);
}
return returnValue;
};
}();

View file

@ -0,0 +1,391 @@
/*
Copyright (c) 2004-2006, The Dojo Foundation
All Rights Reserved.
Licensed under the Academic Free License version 2.1 or above OR the
modified BSD license. For more information on Dojo licensing, see:
http://dojotoolkit.org/community/licensing.shtml
*/
dojo.provide("dojo.uuid.TimeBasedGenerator");
dojo.require("dojo.lang.*");
dojo.uuid.TimeBasedGenerator = new function() {
// --------------------------------------------------
// Public constants
// --------------------------------------------------
// Number of hours between October 15, 1582 and January 1, 1970:
this.GREGORIAN_CHANGE_OFFSET_IN_HOURS = 3394248;
// Number of seconds between October 15, 1582 and January 1, 1970:
// this.GREGORIAN_CHANGE_OFFSET_IN_SECONDS = 12219292800;
// --------------------------------------------------
// Private variables
// --------------------------------------------------
var _uuidPseudoNodeString = null;
var _uuidClockSeqString = null;
var _dateValueOfPreviousUuid = null;
var _nextIntraMillisecondIncrement = 0;
var _cachedMillisecondsBetween1582and1970 = null;
var _cachedHundredNanosecondIntervalsPerMillisecond = null;
var _uniformNode = null;
var HEX_RADIX = 16;
// --------------------------------------------------
// Private functions
// --------------------------------------------------
/**
* Given an array which holds a 64-bit number broken into 4 16-bit elements,
* this method carries any excess bits (greater than 16-bits) from each array
* element into the next.
*
* @param arrayA An array with 4 elements, each of which is a 16-bit number.
*/
function _carry(arrayA) {
arrayA[2] += arrayA[3] >>> 16;
arrayA[3] &= 0xFFFF;
arrayA[1] += arrayA[2] >>> 16;
arrayA[2] &= 0xFFFF;
arrayA[0] += arrayA[1] >>> 16;
arrayA[1] &= 0xFFFF;
dojo.lang.assert((arrayA[0] >>> 16) === 0);
}
/**
* Given a floating point number, this method returns an array which holds a
* 64-bit number broken into 4 16-bit elements.
*
* @param x A floating point number.
* @return An array with 4 elements, each of which is a 16-bit number.
*/
function _get64bitArrayFromFloat(x) {
var result = new Array(0, 0, 0, 0);
result[3] = x % 0x10000;
x -= result[3];
x /= 0x10000;
result[2] = x % 0x10000;
x -= result[2];
x /= 0x10000;
result[1] = x % 0x10000;
x -= result[1];
x /= 0x10000;
result[0] = x;
return result;
}
/**
* Takes two arrays, each of which holds a 64-bit number broken into 4
* 16-bit elements, and returns a new array that holds a 64-bit number
* that is the sum of the two original numbers.
*
* @param arrayA An array with 4 elements, each of which is a 16-bit number.
* @param arrayB An array with 4 elements, each of which is a 16-bit number.
* @return An array with 4 elements, each of which is a 16-bit number.
*/
function _addTwo64bitArrays(arrayA, arrayB) {
dojo.lang.assertType(arrayA, Array);
dojo.lang.assertType(arrayB, Array);
dojo.lang.assert(arrayA.length == 4);
dojo.lang.assert(arrayB.length == 4);
var result = new Array(0, 0, 0, 0);
result[3] = arrayA[3] + arrayB[3];
result[2] = arrayA[2] + arrayB[2];
result[1] = arrayA[1] + arrayB[1];
result[0] = arrayA[0] + arrayB[0];
_carry(result);
return result;
}
/**
* Takes two arrays, each of which holds a 64-bit number broken into 4
* 16-bit elements, and returns a new array that holds a 64-bit number
* that is the product of the two original numbers.
*
* @param arrayA An array with 4 elements, each of which is a 16-bit number.
* @param arrayB An array with 4 elements, each of which is a 16-bit number.
* @return An array with 4 elements, each of which is a 16-bit number.
*/
function _multiplyTwo64bitArrays(arrayA, arrayB) {
dojo.lang.assertType(arrayA, Array);
dojo.lang.assertType(arrayB, Array);
dojo.lang.assert(arrayA.length == 4);
dojo.lang.assert(arrayB.length == 4);
var overflow = false;
if (arrayA[0] * arrayB[0] !== 0) { overflow = true; }
if (arrayA[0] * arrayB[1] !== 0) { overflow = true; }
if (arrayA[0] * arrayB[2] !== 0) { overflow = true; }
if (arrayA[1] * arrayB[0] !== 0) { overflow = true; }
if (arrayA[1] * arrayB[1] !== 0) { overflow = true; }
if (arrayA[2] * arrayB[0] !== 0) { overflow = true; }
dojo.lang.assert(!overflow);
var result = new Array(0, 0, 0, 0);
result[0] += arrayA[0] * arrayB[3];
_carry(result);
result[0] += arrayA[1] * arrayB[2];
_carry(result);
result[0] += arrayA[2] * arrayB[1];
_carry(result);
result[0] += arrayA[3] * arrayB[0];
_carry(result);
result[1] += arrayA[1] * arrayB[3];
_carry(result);
result[1] += arrayA[2] * arrayB[2];
_carry(result);
result[1] += arrayA[3] * arrayB[1];
_carry(result);
result[2] += arrayA[2] * arrayB[3];
_carry(result);
result[2] += arrayA[3] * arrayB[2];
_carry(result);
result[3] += arrayA[3] * arrayB[3];
_carry(result);
return result;
}
/**
* Pads a string with leading zeros and returns the result.
* For example:
* <pre>
* result = _padWithLeadingZeros("abc", 6);
* dojo.lang.assert(result == "000abc");
* </pre>
*
* @param string A string to add padding to.
* @param desiredLength The number of characters the return string should have.
* @return A string.
*/
function _padWithLeadingZeros(string, desiredLength) {
while (string.length < desiredLength) {
string = "0" + string;
}
return string;
}
/**
* Returns a randomly generated 8-character string of hex digits.
*
* @return An 8-character hex string.
*/
function _generateRandomEightCharacterHexString() {
// FIXME: This probably isn't a very high quality random number.
// Make random32bitNumber be a randomly generated floating point number
// between 0 and (4,294,967,296 - 1), inclusive.
var random32bitNumber = Math.floor( (Math.random() % 1) * Math.pow(2, 32) );
var eightCharacterString = random32bitNumber.toString(HEX_RADIX);
while (eightCharacterString.length < 8) {
eightCharacterString = "0" + eightCharacterString;
}
return eightCharacterString;
}
/**
* Generates a time-based UUID, meaning a version 1 UUID. JavaScript
* code running in a browser doesn't have access to the IEEE 802.3 address
* of the computer, so if a node value isn't supplied, we generate a random
* pseudonode value instead.
*
* @param node Optional. A 12-character string to use as the node in the new UUID.
* @return Returns a 36 character string, which will look something like "b4308fb0-86cd-11da-a72b-0800200c9a66".
*/
function _generateUuidString(node) {
dojo.lang.assertType(node, [String, "optional"]);
if (node) {
dojo.lang.assert(node.length == 12);
} else {
if (_uniformNode) {
node = _uniformNode;
} else {
if (!_uuidPseudoNodeString) {
var pseudoNodeIndicatorBit = 0x8000;
var random15bitNumber = Math.floor( (Math.random() % 1) * Math.pow(2, 15) );
var leftmost4HexCharacters = (pseudoNodeIndicatorBit | random15bitNumber).toString(HEX_RADIX);
_uuidPseudoNodeString = leftmost4HexCharacters + _generateRandomEightCharacterHexString();
}
node = _uuidPseudoNodeString;
}
}
if (!_uuidClockSeqString) {
var variantCodeForDCEUuids = 0x8000; // 10--------------, i.e. uses only first two of 16 bits.
var random14bitNumber = Math.floor( (Math.random() % 1) * Math.pow(2, 14) );
_uuidClockSeqString = (variantCodeForDCEUuids | random14bitNumber).toString(HEX_RADIX);
}
// Maybe we should think about trying to make the code more readable to
// newcomers by creating a class called "WholeNumber" that encapsulates
// the methods and data structures for working with these arrays that
// hold 4 16-bit numbers? And then these variables below have names
// like "wholeSecondsPerHour" rather than "arraySecondsPerHour"?
var now = new Date();
var millisecondsSince1970 = now.valueOf(); // milliseconds since midnight 01 January, 1970 UTC.
var nowArray = _get64bitArrayFromFloat(millisecondsSince1970);
if (!_cachedMillisecondsBetween1582and1970) {
var arraySecondsPerHour = _get64bitArrayFromFloat(60 * 60);
var arrayHoursBetween1582and1970 = _get64bitArrayFromFloat(dojo.uuid.TimeBasedGenerator.GREGORIAN_CHANGE_OFFSET_IN_HOURS);
var arraySecondsBetween1582and1970 = _multiplyTwo64bitArrays(arrayHoursBetween1582and1970, arraySecondsPerHour);
var arrayMillisecondsPerSecond = _get64bitArrayFromFloat(1000);
_cachedMillisecondsBetween1582and1970 = _multiplyTwo64bitArrays(arraySecondsBetween1582and1970, arrayMillisecondsPerSecond);
_cachedHundredNanosecondIntervalsPerMillisecond = _get64bitArrayFromFloat(10000);
}
var arrayMillisecondsSince1970 = nowArray;
var arrayMillisecondsSince1582 = _addTwo64bitArrays(_cachedMillisecondsBetween1582and1970, arrayMillisecondsSince1970);
var arrayHundredNanosecondIntervalsSince1582 = _multiplyTwo64bitArrays(arrayMillisecondsSince1582, _cachedHundredNanosecondIntervalsPerMillisecond);
if (now.valueOf() == _dateValueOfPreviousUuid) {
arrayHundredNanosecondIntervalsSince1582[3] += _nextIntraMillisecondIncrement;
_carry(arrayHundredNanosecondIntervalsSince1582);
_nextIntraMillisecondIncrement += 1;
if (_nextIntraMillisecondIncrement == 10000) {
// If we've gotten to here, it means we've already generated 10,000
// UUIDs in this single millisecond, which is the most that the UUID
// timestamp field allows for. So now we'll just sit here and wait
// for a fraction of a millisecond, so as to ensure that the next
// time this method is called there will be a different millisecond
// value in the timestamp field.
while (now.valueOf() == _dateValueOfPreviousUuid) {
now = new Date();
}
}
} else {
_dateValueOfPreviousUuid = now.valueOf();
_nextIntraMillisecondIncrement = 1;
}
var hexTimeLowLeftHalf = arrayHundredNanosecondIntervalsSince1582[2].toString(HEX_RADIX);
var hexTimeLowRightHalf = arrayHundredNanosecondIntervalsSince1582[3].toString(HEX_RADIX);
var hexTimeLow = _padWithLeadingZeros(hexTimeLowLeftHalf, 4) + _padWithLeadingZeros(hexTimeLowRightHalf, 4);
var hexTimeMid = arrayHundredNanosecondIntervalsSince1582[1].toString(HEX_RADIX);
hexTimeMid = _padWithLeadingZeros(hexTimeMid, 4);
var hexTimeHigh = arrayHundredNanosecondIntervalsSince1582[0].toString(HEX_RADIX);
hexTimeHigh = _padWithLeadingZeros(hexTimeHigh, 3);
var hyphen = "-";
var versionCodeForTimeBasedUuids = "1"; // binary2hex("0001")
var resultUuid = hexTimeLow + hyphen + hexTimeMid + hyphen +
versionCodeForTimeBasedUuids + hexTimeHigh + hyphen +
_uuidClockSeqString + hyphen + node;
resultUuid = resultUuid.toLowerCase();
return resultUuid;
}
// --------------------------------------------------
// Public functions
// --------------------------------------------------
/**
* Sets the 'node' value that will be included in generated UUIDs.
*
* @param node A 12-character hex string representing a pseudoNode or hardwareNode.
*/
this.setNode = function(node) {
dojo.lang.assert((node === null) || (node.length == 12));
_uniformNode = node;
};
/**
* Returns the 'node' value that will be included in generated UUIDs.
*
* @return A 12-character hex string representing a pseudoNode or hardwareNode.
*/
this.getNode = function() {
return _uniformNode;
};
/**
* This function generates time-based UUIDs, meaning "version 1" UUIDs.
*
* For more info, see
* http://www.webdav.org/specs/draft-leach-uuids-guids-01.txt
* http://www.infonuovo.com/dma/csdocs/sketch/instidid.htm
* http://kruithof.xs4all.nl/uuid/uuidgen
* http://www.opengroup.org/onlinepubs/009629399/apdxa.htm#tagcjh_20
* http://jakarta.apache.org/commons/sandbox/id/apidocs/org/apache/commons/id/uuid/clock/Clock.html
*
* Examples:
* <pre>
* var generate = dojo.uuid.TimeBasedGenerator.generate;
* var uuid; // an instance of dojo.uuid.Uuid
* var string; // a simple string literal
* string = generate();
* string = generate(String);
* uuid = generate(dojo.uuid.Uuid);
* string = generate("017bf397618a");
* string = generate({node: "017bf397618a"}); // hardwareNode
* string = generate({node: "f17bf397618a"}); // pseudoNode
* string = generate({hardwareNode: "017bf397618a"});
* string = generate({pseudoNode: "f17bf397618a"});
* string = generate({node: "017bf397618a", returnType: String});
* uuid = generate({node: "017bf397618a", returnType: dojo.uuid.Uuid});
* dojo.uuid.TimeBasedGenerator.setNode("017bf397618a");
* string = generate(); // the generated UUID has node == "017bf397618a"
* uuid = generate(dojo.uuid.Uuid); // the generated UUID has node == "017bf397618a"
* </pre>
*
* @param class The type of instance to return.
* @param node A 12-character hex string representing a pseudoNode or hardwareNode.
* @namedParam node A 12-character hex string representing a pseudoNode or hardwareNode.
* @namedParam hardwareNode A 12-character hex string containing an IEEE 802.3 network node identificator.
* @namedParam pseudoNode A 12-character hex string representing a pseudoNode.
* @namedParam returnType The type of instance to return.
* @return A newly generated version 1 UUID.
*/
this.generate = function(input) {
var nodeString = null;
var returnType = null;
if (input) {
if (dojo.lang.isObject(input) && !dojo.lang.isBuiltIn(input)) {
var namedParameters = input;
dojo.lang.assertValidKeywords(namedParameters, ["node", "hardwareNode", "pseudoNode", "returnType"]);
var node = namedParameters["node"];
var hardwareNode = namedParameters["hardwareNode"];
var pseudoNode = namedParameters["pseudoNode"];
nodeString = (node || pseudoNode || hardwareNode);
if (nodeString) {
var firstCharacter = nodeString.charAt(0);
var firstDigit = parseInt(firstCharacter, HEX_RADIX);
if (hardwareNode) {
dojo.lang.assert((firstDigit >= 0x0) && (firstDigit <= 0x7));
}
if (pseudoNode) {
dojo.lang.assert((firstDigit >= 0x8) && (firstDigit <= 0xF));
}
}
returnType = namedParameters["returnType"];
dojo.lang.assertType(returnType, [Function, "optional"]);
} else {
if (dojo.lang.isString(input)) {
nodeString = input;
returnType = null;
} else {
if (dojo.lang.isFunction(input)) {
nodeString = null;
returnType = input;
}
}
}
if (nodeString) {
dojo.lang.assert(nodeString.length == 12);
var integer = parseInt(nodeString, HEX_RADIX);
dojo.lang.assert(isFinite(integer));
}
dojo.lang.assertType(returnType, [Function, "optional"]);
}
var uuidString = _generateUuidString(nodeString);
var returnValue;
if (returnType && (returnType != String)) {
returnValue = new returnType(uuidString);
} else {
returnValue = uuidString;
}
return returnValue;
};
}();

423
webapp/web/src/uuid/Uuid.js Normal file
View file

@ -0,0 +1,423 @@
/*
Copyright (c) 2004-2006, The Dojo Foundation
All Rights Reserved.
Licensed under the Academic Free License version 2.1 or above OR the
modified BSD license. For more information on Dojo licensing, see:
http://dojotoolkit.org/community/licensing.shtml
*/
dojo.provide("dojo.uuid.Uuid");
dojo.require("dojo.lang.*");
// -------------------------------------------------------------------
// Constructor
// -------------------------------------------------------------------
/**
* The Uuid class offers methods for inspecting existing UUIDs.
*
* Examples:
* <pre>
* var uuid;
* uuid = new dojo.uuid.Uuid("3b12f1df-5232-4804-897e-917bf397618a");
* uuid = new dojo.uuid.Uuid(); // "00000000-0000-0000-0000-000000000000"
* uuid = new dojo.uuid.Uuid(dojo.uuid.RandomGenerator);
* uuid = new dojo.uuid.Uuid(dojo.uuid.TimeBasedGenerator);
*
* dojo.uuid.Uuid.setGenerator(dojo.uuid.RandomGenerator);
* uuid = new dojo.uuid.Uuid();
* dojo.lang.assert(!uuid.isEqual(dojo.uuid.Uuid.NIL_UUID));
* </pre>
*
* @scope public instance constructor
* @param uuidString A 36-character string that conforms to the UUID spec.
* @param generator A UUID generator, such as dojo.uuid.TimeBasedGenerator.
*/
dojo.uuid.Uuid = function(input) {
this._uuidString = dojo.uuid.Uuid.NIL_UUID;
if (input) {
if (dojo.lang.isString(input)) {
this._uuidString = input.toLowerCase();
dojo.lang.assert(this.isValid());
} else {
if (dojo.lang.isObject(input) && input.generate) {
var generator = input;
this._uuidString = generator.generate();
dojo.lang.assert(this.isValid());
} else {
// we got passed something other than a string
dojo.lang.assert(false, "The dojo.uuid.Uuid() constructor must be initializated with a UUID string.");
}
}
} else {
var ourGenerator = dojo.uuid.Uuid.getGenerator();
if (ourGenerator) {
this._uuidString = ourGenerator.generate();
dojo.lang.assert(this.isValid());
}
}
};
// -------------------------------------------------------------------
// Public constants
// -------------------------------------------------------------------
dojo.uuid.Uuid.NIL_UUID = "00000000-0000-0000-0000-000000000000";
dojo.uuid.Uuid.Version = {
UNKNOWN: 0,
TIME_BASED: 1,
DCE_SECURITY: 2,
NAME_BASED_MD5: 3,
RANDOM: 4,
NAME_BASED_SHA1: 5 };
dojo.uuid.Uuid.Variant = {
NCS: "0",
DCE: "10",
MICROSOFT: "110",
UNKNOWN: "111" };
dojo.uuid.Uuid.HEX_RADIX = 16;
// -------------------------------------------------------------------
// Public class methods
// -------------------------------------------------------------------
/**
* Given two UUIDs to compare, this method returns 0, 1, or -1.
* This method is designed to be used by sorting routines, like
* the JavaScript built-in Array sort() method.
* This implementation is intended to match the sample
* implementation in IETF RFC 4122:
* http://www.ietf.org/rfc/rfc4122.txt
*
* Example:
* <pre>
* var generator = dojo.uuid.TimeBasedGenerator;
* var a = new dojo.uuid.Uuid(generator);
* var b = new dojo.uuid.Uuid(generator);
* var c = new dojo.uuid.Uuid(generator);
* var array = new Array(a, b, c);
* array.sort(dojo.uuid.Uuid.compare);
* </pre>
*
* @param uuidOne A dojo.uuid.Uuid instance, or a string representing a UUID.
* @param uuidTwo A dojo.uuid.Uuid instance, or a string representing a UUID.
* @return Returns either 0, 1, or -1.
*/
dojo.uuid.Uuid.compare = function(uuidOne, uuidTwo) {
var uuidStringOne = uuidOne.toString();
var uuidStringTwo = uuidTwo.toString();
if (uuidStringOne > uuidStringTwo) return 1;
if (uuidStringOne < uuidStringTwo) return -1;
return 0;
};
/**
* Sets the default generator, which will be used by the
* "new dojo.uuid.Uuid()" constructor if no parameters
* are passed in.
*
* @param generator A UUID generator, such as dojo.uuid.TimeBasedGenerator.
* @return Returns true or false. True if this UUID is equal to the otherUuid.
*/
dojo.uuid.Uuid.setGenerator = function(generator) {
dojo.lang.assert(!generator || (dojo.lang.isObject(generator) && generator.generate));
dojo.uuid.Uuid._ourGenerator = generator;
};
/**
* Returns the default generator. See setGenerator().
*
* @return A UUID generator, such as dojo.uuid.TimeBasedGenerator.
*/
dojo.uuid.Uuid.getGenerator = function(generator) {
return dojo.uuid.Uuid._ourGenerator;
};
// -------------------------------------------------------------------
// Public instance methods
// -------------------------------------------------------------------
/**
* Returns a 36-character string representing the UUID, such
* as "3b12f1df-5232-4804-897e-917bf397618a".
*
* Examples:
* <pre>
* var uuid = new dojo.uuid.Uuid(dojo.uuid.TimeBasedGenerator);
* var s;
* s = uuid.toString(); // eb529fec-6498-11d7-b236-000629ba5445
* s = uuid.toString('{}'); // {eb529fec-6498-11d7-b236-000629ba5445}
* s = uuid.toString('()'); // (eb529fec-6498-11d7-b236-000629ba5445)
* s = uuid.toString('""'); // "eb529fec-6498-11d7-b236-000629ba5445"
* s = uuid.toString("''"); // 'eb529fec-6498-11d7-b236-000629ba5445'
* s = uuid.toString('!-'); // eb529fec649811d7b236000629ba5445
* s = uuid.toString('urn'); // urn:uuid:eb529fec-6498-11d7-b236-000629ba5445
* </pre>
*
* @param uuidOne A dojo.uuid.Uuid instance, or a string representing a UUID.
* @return Returns a standard 36-character UUID string, or something similar.
*/
dojo.uuid.Uuid.prototype.toString = function(format) {
if (format) {
switch (format) {
case '{}':
return '{' + this._uuidString + '}';
break;
case '()':
return '(' + this._uuidString + ')';
break;
case '""':
return '"' + this._uuidString + '"';
break;
case "''":
return "'" + this._uuidString + "'";
break;
case 'urn':
return 'urn:uuid:' + this._uuidString;
break;
case '!-':
return this._uuidString.split('-').join('');
break;
default:
// we got passed something other than what we expected
dojo.lang.assert(false, "The toString() method of dojo.uuid.Uuid was passed a bogus format.");
}
} else {
return this._uuidString;
}
};
/**
* Compares this UUID to another UUID, and returns 0, 1, or -1.
* This implementation is intended to match the sample
* implementation in IETF RFC 4122:
* http://www.ietf.org/rfc/rfc4122.txt
*
* @param otherUuid A dojo.uuid.Uuid instance, or a string representing a UUID.
* @return Returns either 0, 1, or -1.
*/
dojo.uuid.Uuid.prototype.compare = function(otherUuid) {
return dojo.uuid.Uuid.compare(this, otherUuid);
};
/**
* Returns true if this UUID is equal to the otherUuid, or
* false otherwise.
*
* @param otherUuid A dojo.uuid.Uuid instance, or a string representing a UUID.
* @return Returns true or false. True if this UUID is equal to the otherUuid.
*/
dojo.uuid.Uuid.prototype.isEqual = function(otherUuid) {
return (this.compare(otherUuid) == 0);
};
/**
* Returns true if the UUID was initialized with a valid value.
*
* @return True if the UUID is valid, or false if it is not.
*/
dojo.uuid.Uuid.prototype.isValid = function() {
try {
dojo.lang.assertType(this._uuidString, String);
dojo.lang.assert(this._uuidString.length == 36);
dojo.lang.assert(this._uuidString == this._uuidString.toLowerCase());
var arrayOfParts = this._uuidString.split("-");
dojo.lang.assert(arrayOfParts.length == 5);
dojo.lang.assert(arrayOfParts[0].length == 8);
dojo.lang.assert(arrayOfParts[1].length == 4);
dojo.lang.assert(arrayOfParts[2].length == 4);
dojo.lang.assert(arrayOfParts[3].length == 4);
dojo.lang.assert(arrayOfParts[4].length == 12);
for (var i in arrayOfParts) {
var part = arrayOfParts[i];
var integer = parseInt(part, dojo.uuid.Uuid.HEX_RADIX);
dojo.lang.assert(isFinite(integer));
}
return true;
} catch (e) {
return false;
}
};
/**
* Returns a variant code that indicates what type of UUID this is.
* For example:
* <pre>
* var uuid = new dojo.uuid.Uuid("3b12f1df-5232-4804-897e-917bf397618a");
* var variant = uuid.getVariant();
* dojo.lang.assert(variant == dojo.uuid.Uuid.Variant.DCE);
* </pre>
*
* @return Returns one of the enumarted dojo.uuid.Uuid.Variant values.
*/
dojo.uuid.Uuid.prototype.getVariant = function() {
// "3b12f1df-5232-4804-897e-917bf397618a"
// ^
// |
// (variant "10__" == DCE)
var variantCharacter = this._uuidString.charAt(19);
var variantNumber = parseInt(variantCharacter, dojo.uuid.Uuid.HEX_RADIX);
dojo.lang.assert((variantNumber >= 0) && (variantNumber <= 16));
if (!dojo.uuid.Uuid._ourVariantLookupTable) {
var Variant = dojo.uuid.Uuid.Variant;
var lookupTable = [];
lookupTable[0x0] = Variant.NCS; // 0000
lookupTable[0x1] = Variant.NCS; // 0001
lookupTable[0x2] = Variant.NCS; // 0010
lookupTable[0x3] = Variant.NCS; // 0011
lookupTable[0x4] = Variant.NCS; // 0100
lookupTable[0x5] = Variant.NCS; // 0101
lookupTable[0x6] = Variant.NCS; // 0110
lookupTable[0x7] = Variant.NCS; // 0111
lookupTable[0x8] = Variant.DCE; // 1000
lookupTable[0x9] = Variant.DCE; // 1001
lookupTable[0xA] = Variant.DCE; // 1010
lookupTable[0xB] = Variant.DCE; // 1011
lookupTable[0xC] = Variant.MICROSOFT; // 1100
lookupTable[0xD] = Variant.MICROSOFT; // 1101
lookupTable[0xE] = Variant.UNKNOWN; // 1110
lookupTable[0xF] = Variant.UNKNOWN; // 1111
dojo.uuid.Uuid._ourVariantLookupTable = lookupTable;
}
return dojo.uuid.Uuid._ourVariantLookupTable[variantNumber];
};
/**
* Returns a version number that indicates what type of UUID this is.
* For example:
* <pre>
* var uuid = new dojo.uuid.Uuid("b4308fb0-86cd-11da-a72b-0800200c9a66");
* var version = uuid.getVersion();
* dojo.lang.assert(version == dojo.uuid.Uuid.Version.TIME_BASED);
* </pre>
*
* @return Returns one of the enumerated dojo.uuid.Uuid.Version values.
* @throws Throws an Error if this is not a DCE Variant UUID.
*/
dojo.uuid.Uuid.prototype.getVersion = function() {
if (!this._versionNumber) {
var errorMessage = "Called getVersion() on a dojo.uuid.Uuid that was not a DCE Variant UUID.";
dojo.lang.assert(this.getVariant() == dojo.uuid.Uuid.Variant.DCE, errorMessage);
// "b4308fb0-86cd-11da-a72b-0800200c9a66"
// ^
// |
// (version 1 == TIME_BASED)
var versionCharacter = this._uuidString.charAt(14);
this._versionNumber = parseInt(versionCharacter, dojo.uuid.Uuid.HEX_RADIX);
}
return this._versionNumber;
};
/**
* If this is a version 1 UUID (a time-based UUID), this method returns a
* 12-character string with the "node" or "pseudonode" portion of the UUID,
* which is the rightmost 12 characters.
* Throws an Error if this is not a version 1 UUID.
*
* @return Returns a 12-character string, which will look something like "917bf397618a".
* @throws Throws an Error if this is not a version 1 UUID.
*/
dojo.uuid.Uuid.prototype.getNode = function() {
if (!this._nodeString) {
var errorMessage = "Called getNode() on a dojo.uuid.Uuid that was not a TIME_BASED UUID.";
dojo.lang.assert(this.getVersion() == dojo.uuid.Uuid.Version.TIME_BASED, errorMessage);
var arrayOfStrings = this._uuidString.split('-');
this._nodeString = arrayOfStrings[4];
}
return this._nodeString;
};
/**
* If this is a version 1 UUID (a time-based UUID), this method returns
* the timestamp value encoded in the UUID. The caller can ask for the
* timestamp to be returned either as a JavaScript Date object or as a
* 15-character string of hex digits.
* Throws an Error if this is not a version 1 UUID.
*
* Examples:
* <pre>
* var uuid = new dojo.uuid.Uuid("b4308fb0-86cd-11da-a72b-0800200c9a66");
* var date, string, hexString;
* date = uuid.getTimestamp(); // returns a JavaScript Date
* date = uuid.getTimestamp(Date); //
* string = uuid.getTimestamp(String); // "Mon, 16 Jan 2006 20:21:41 GMT"
* hexString = uuid.getTimestamp("hex"); // "1da86cdb4308fb0"
* </pre>
*
* @return Returns the timestamp value as a JavaScript Date object or a 15-character string of hex digits.
* @throws Throws an Error if this is not a version 1 UUID.
*/
dojo.uuid.Uuid.prototype.getTimestamp = function(returnType) {
var errorMessage = "Called getTimestamp() on a dojo.uuid.Uuid that was not a TIME_BASED UUID.";
dojo.lang.assert(this.getVersion() == dojo.uuid.Uuid.Version.TIME_BASED, errorMessage);
if (!returnType) {returnType = null};
switch (returnType) {
case "string":
case String:
return this.getTimestamp(Date).toUTCString();
break;
case "hex":
// Return a 15-character string of hex digits containing the
// timestamp for this UUID, with the high-order bits first.
if (!this._timestampAsHexString) {
var arrayOfStrings = this._uuidString.split('-');
var hexTimeLow = arrayOfStrings[0];
var hexTimeMid = arrayOfStrings[1];
var hexTimeHigh = arrayOfStrings[2];
// Chop off the leading "1" character, which is the UUID
// version number for time-based UUIDs.
hexTimeHigh = hexTimeHigh.slice(1);
this._timestampAsHexString = hexTimeHigh + hexTimeMid + hexTimeLow;
dojo.lang.assert(this._timestampAsHexString.length == 15);
}
return this._timestampAsHexString;
break;
case null: // no returnType was specified, so default to Date
case "date":
case Date:
// Return a JavaScript Date object.
if (!this._timestampAsDate) {
var GREGORIAN_CHANGE_OFFSET_IN_HOURS = 3394248;
var arrayOfParts = this._uuidString.split('-');
var timeLow = parseInt(arrayOfParts[0], dojo.uuid.Uuid.HEX_RADIX);
var timeMid = parseInt(arrayOfParts[1], dojo.uuid.Uuid.HEX_RADIX);
var timeHigh = parseInt(arrayOfParts[2], dojo.uuid.Uuid.HEX_RADIX);
var hundredNanosecondIntervalsSince1582 = timeHigh & 0x0FFF;
hundredNanosecondIntervalsSince1582 <<= 16;
hundredNanosecondIntervalsSince1582 += timeMid;
// What we really want to do next is shift left 32 bits, but the
// result will be too big to fit in an int, so we'll multiply by 2^32,
// and the result will be a floating point approximation.
hundredNanosecondIntervalsSince1582 *= 0x100000000;
hundredNanosecondIntervalsSince1582 += timeLow;
var millisecondsSince1582 = hundredNanosecondIntervalsSince1582 / 10000;
// Again, this will be a floating point approximation.
// We can make things exact later if we need to.
var secondsPerHour = 60 * 60;
var hoursBetween1582and1970 = GREGORIAN_CHANGE_OFFSET_IN_HOURS;
var secondsBetween1582and1970 = hoursBetween1582and1970 * secondsPerHour;
var millisecondsBetween1582and1970 = secondsBetween1582and1970 * 1000;
var millisecondsSince1970 = millisecondsSince1582 - millisecondsBetween1582and1970;
this._timestampAsDate = new Date(millisecondsSince1970);
}
return this._timestampAsDate;
break;
default:
// we got passed something other than a valid returnType
dojo.lang.assert(false, "The getTimestamp() method dojo.uuid.Uuid was passed a bogus returnType: " + returnType);
break;
}
};

View file

@ -0,0 +1,22 @@
/*
Copyright (c) 2004-2006, The Dojo Foundation
All Rights Reserved.
Licensed under the Academic Free License version 2.1 or above OR the
modified BSD license. For more information on Dojo licensing, see:
http://dojotoolkit.org/community/licensing.shtml
*/
dojo.kwCompoundRequire({
common: [
"dojo.uuid.Uuid",
"dojo.uuid.LightweightGenerator",
"dojo.uuid.RandomGenerator",
"dojo.uuid.TimeBasedGenerator",
"dojo.uuid.NameBasedGenerator",
"dojo.uuid.NilGenerator"
]
});
dojo.provide("dojo.uuid.*");