Wentao Shang | bd63e46 | 2012-12-03 16:19:33 -0800 | [diff] [blame] | 1 | /** |
Jeff Thompson | 87021f7 | 2012-11-18 17:40:06 -0800 | [diff] [blame] | 2 | * @author: Meki Cheraoui, Jeff Thompson |
Jeff Thompson | 745026e | 2012-10-13 12:49:20 -0700 | [diff] [blame] | 3 | * See COPYING for copyright and distribution information. |
Jeff Thompson | 4e8b770 | 2012-10-21 23:42:27 -0700 | [diff] [blame] | 4 | * This class represents a Name as an array of components where each is a byte array. |
Meki Cherkaoui | f441d3a | 2012-04-22 15:17:52 -0700 | [diff] [blame] | 5 | */ |
| 6 | |
Jeff Thompson | 87021f7 | 2012-11-18 17:40:06 -0800 | [diff] [blame] | 7 | /* |
| 8 | * Create a new Name from _components. |
| 9 | * If _components is a string, parse it as a URI. Otherwise it is an array of components |
| 10 | * where each is a string, byte array, ArrayBuffer or Uint8Array. |
| 11 | * Convert and store as an array of Uint8Array. |
| 12 | * If a component is a string, encode as utf8. |
| 13 | */ |
Jeff Thompson | f3bd359 | 2012-09-29 23:25:30 -0700 | [diff] [blame] | 14 | var Name = function Name(_components){ |
Jeff Thompson | 87021f7 | 2012-11-18 17:40:06 -0800 | [diff] [blame] | 15 | if( typeof _components == 'string') { |
Jeff Thompson | 86aea88 | 2012-09-29 17:32:48 -0700 | [diff] [blame] | 16 | if(LOG>3)console.log('Content Name String '+_components); |
Jeff Thompson | 87021f7 | 2012-11-18 17:40:06 -0800 | [diff] [blame] | 17 | this.components = Name.createNameArray(_components); |
Meki Cherkaoui | f441d3a | 2012-04-22 15:17:52 -0700 | [diff] [blame] | 18 | } |
Jeff Thompson | 87021f7 | 2012-11-18 17:40:06 -0800 | [diff] [blame] | 19 | else if(typeof _components === 'object'){ |
Jeff Thompson | 86aea88 | 2012-09-29 17:32:48 -0700 | [diff] [blame] | 20 | if(LOG>4)console.log('Content Name Array '+_components); |
Jeff Thompson | 87021f7 | 2012-11-18 17:40:06 -0800 | [diff] [blame] | 21 | this.components = []; |
| 22 | for (var i = 0; i < _components.length; ++i) |
| 23 | this.add(_components[i]); |
Meki Cherkaoui | f441d3a | 2012-04-22 15:17:52 -0700 | [diff] [blame] | 24 | } |
Jeff Thompson | 87021f7 | 2012-11-18 17:40:06 -0800 | [diff] [blame] | 25 | else if(_components==null) |
Jeff Thompson | e85ff1d | 2012-09-29 21:21:57 -0700 | [diff] [blame] | 26 | this.components =[]; |
Jeff Thompson | 87021f7 | 2012-11-18 17:40:06 -0800 | [diff] [blame] | 27 | else |
Meki Cherkaoui | f3d8f69 | 2012-05-18 15:44:28 -0700 | [diff] [blame] | 28 | if(LOG>1)console.log("NO CONTENT NAME GIVEN"); |
Meki Cherkaoui | f441d3a | 2012-04-22 15:17:52 -0700 | [diff] [blame] | 29 | }; |
| 30 | |
Jeff Thompson | 0d3f203 | 2012-11-04 12:55:27 -0800 | [diff] [blame] | 31 | Name.prototype.getName = function() { |
| 32 | return this.to_uri(); |
Meki Cherkaoui | 8f17361 | 2012-06-06 01:05:40 -0700 | [diff] [blame] | 33 | }; |
Meki Cherkaoui | f441d3a | 2012-04-22 15:17:52 -0700 | [diff] [blame] | 34 | |
Jeff Thompson | 87021f7 | 2012-11-18 17:40:06 -0800 | [diff] [blame] | 35 | /* Parse name as a URI and return an array of Uint8Array components. |
| 36 | * |
| 37 | */ |
Jeff Thompson | 0d3f203 | 2012-11-04 12:55:27 -0800 | [diff] [blame] | 38 | Name.createNameArray = function(name) { |
| 39 | name = name.trim(); |
| 40 | if (name.length <= 0) |
| 41 | return []; |
| 42 | |
| 43 | var iColon = name.indexOf(':'); |
| 44 | if (iColon >= 0) { |
| 45 | // Make sure the colon came before a '/'. |
| 46 | var iFirstSlash = name.indexOf('/'); |
| 47 | if (iFirstSlash < 0 || iColon < iFirstSlash) |
Jeff Thompson | bd82926 | 2012-11-30 22:28:37 -0800 | [diff] [blame] | 48 | // Omit the leading protocol such as ndn: |
Jeff Thompson | 0d3f203 | 2012-11-04 12:55:27 -0800 | [diff] [blame] | 49 | name = name.substr(iColon + 1, name.length - iColon - 1).trim(); |
Jeff Thompson | 4e8b770 | 2012-10-21 23:42:27 -0700 | [diff] [blame] | 50 | } |
Jeff Thompson | 0d3f203 | 2012-11-04 12:55:27 -0800 | [diff] [blame] | 51 | |
| 52 | if (name[0] == '/') { |
| 53 | if (name.length >= 2 && name[1] == '/') { |
| 54 | // Strip the authority following "//". |
| 55 | var iAfterAuthority = name.indexOf('/', 2); |
| 56 | if (iAfterAuthority < 0) |
| 57 | // Unusual case: there was only an authority. |
| 58 | return []; |
| 59 | else |
| 60 | name = name.substr(iAfterAuthority + 1, name.length - iAfterAuthority - 1).trim(); |
| 61 | } |
| 62 | else |
| 63 | name = name.substr(1, name.length - 1).trim(); |
| 64 | } |
| 65 | |
| 66 | var array = name.split('/'); |
Jeff Thompson | 9b41100 | 2012-10-21 17:35:16 -0700 | [diff] [blame] | 67 | |
| 68 | // Unescape the components. |
Jeff Thompson | 4e8b770 | 2012-10-21 23:42:27 -0700 | [diff] [blame] | 69 | for (var i = 0; i < array.length; ++i) { |
Jeff Thompson | 78849a7 | 2013-02-03 22:35:54 -0800 | [diff] [blame] | 70 | var component = Name.fromEscapedString(array[i]); |
Jeff Thompson | 4e8b770 | 2012-10-21 23:42:27 -0700 | [diff] [blame] | 71 | |
Jeff Thompson | 78849a7 | 2013-02-03 22:35:54 -0800 | [diff] [blame] | 72 | if (component == null) { |
| 73 | // Ignore the illegal componenent. This also gets rid of a trailing '/'. |
| 74 | array.splice(i, 1); |
| 75 | --i; |
| 76 | continue; |
Jeff Thompson | 4e8b770 | 2012-10-21 23:42:27 -0700 | [diff] [blame] | 77 | } |
| 78 | else |
| 79 | array[i] = component; |
| 80 | } |
Jeff Thompson | 9b41100 | 2012-10-21 17:35:16 -0700 | [diff] [blame] | 81 | |
Meki Cherkaoui | f3d8f69 | 2012-05-18 15:44:28 -0700 | [diff] [blame] | 82 | return array; |
| 83 | } |
Meki Cherkaoui | f441d3a | 2012-04-22 15:17:52 -0700 | [diff] [blame] | 84 | |
| 85 | |
Jeff Thompson | f3bd359 | 2012-09-29 23:25:30 -0700 | [diff] [blame] | 86 | Name.prototype.from_ccnb = function(/*XMLDecoder*/ decoder) { |
Meki Cherkaoui | f441d3a | 2012-04-22 15:17:52 -0700 | [diff] [blame] | 87 | decoder.readStartElement(this.getElementLabel()); |
| 88 | |
| 89 | |
Jeff Thompson | e85ff1d | 2012-09-29 21:21:57 -0700 | [diff] [blame] | 90 | this.components = new Array(); //new ArrayList<byte []>(); |
Meki Cherkaoui | f441d3a | 2012-04-22 15:17:52 -0700 | [diff] [blame] | 91 | |
| 92 | while (decoder.peekStartElement(CCNProtocolDTags.Component)) { |
| 93 | this.add(decoder.readBinaryElement(CCNProtocolDTags.Component)); |
| 94 | } |
| 95 | |
| 96 | decoder.readEndElement(); |
| 97 | }; |
| 98 | |
Jeff Thompson | f3bd359 | 2012-09-29 23:25:30 -0700 | [diff] [blame] | 99 | Name.prototype.to_ccnb = function(/*XMLEncoder*/ encoder) { |
Meki Cherkaoui | f441d3a | 2012-04-22 15:17:52 -0700 | [diff] [blame] | 100 | |
Jeff Thompson | e85ff1d | 2012-09-29 21:21:57 -0700 | [diff] [blame] | 101 | if( this.components ==null ) |
Jeff Thompson | 34a2ec0 | 2012-09-29 21:47:05 -0700 | [diff] [blame] | 102 | throw new Error("CANNOT ENCODE EMPTY CONTENT NAME"); |
Meki Cherkaoui | f441d3a | 2012-04-22 15:17:52 -0700 | [diff] [blame] | 103 | |
| 104 | encoder.writeStartElement(this.getElementLabel()); |
Jeff Thompson | e85ff1d | 2012-09-29 21:21:57 -0700 | [diff] [blame] | 105 | var count = this.components.length; |
Meki Cherkaoui | f441d3a | 2012-04-22 15:17:52 -0700 | [diff] [blame] | 106 | for (var i=0; i < count; i++) { |
Jeff Thompson | e85ff1d | 2012-09-29 21:21:57 -0700 | [diff] [blame] | 107 | encoder.writeElement(CCNProtocolDTags.Component, this.components[i]); |
Meki Cherkaoui | f441d3a | 2012-04-22 15:17:52 -0700 | [diff] [blame] | 108 | } |
| 109 | encoder.writeEndElement(); |
| 110 | }; |
| 111 | |
Jeff Thompson | f3bd359 | 2012-09-29 23:25:30 -0700 | [diff] [blame] | 112 | Name.prototype.getElementLabel = function(){ |
Meki Cherkaoui | f441d3a | 2012-04-22 15:17:52 -0700 | [diff] [blame] | 113 | return CCNProtocolDTags.Name; |
| 114 | }; |
| 115 | |
Jeff Thompson | 87021f7 | 2012-11-18 17:40:06 -0800 | [diff] [blame] | 116 | /* |
| 117 | * component is a string, byte array, ArrayBuffer or Uint8Array. |
| 118 | * Convert to Uint8Array and add to this Name. |
| 119 | * If a component is a string, encode as utf8. |
| 120 | * Return the converted value. |
| 121 | */ |
| 122 | Name.prototype.add = function(component){ |
Jeff Thompson | 9ab151a | 2012-11-24 21:22:30 -0800 | [diff] [blame] | 123 | var result; |
Jeff Thompson | 87021f7 | 2012-11-18 17:40:06 -0800 | [diff] [blame] | 124 | if(typeof component == 'string') |
| 125 | result = DataUtils.stringToUtf8Array(component); |
Jeff Thompson | 87021f7 | 2012-11-18 17:40:06 -0800 | [diff] [blame] | 126 | else if(typeof component == 'object' && component instanceof Uint8Array) |
| 127 | result = new Uint8Array(component); |
Jeff Thompson | 8a97ac5 | 2012-11-24 23:16:02 -0800 | [diff] [blame] | 128 | else if(typeof component == 'object' && component instanceof ArrayBuffer) { |
| 129 | // Make a copy. Don't use ArrayBuffer.slice since it isn't always supported. |
| 130 | result = new Uint8Array(new ArrayBuffer(component.byteLength)); |
| 131 | result.set(new Uint8Array(component)); |
| 132 | } |
Jeff Thompson | 51ab765 | 2012-11-24 21:57:37 -0800 | [diff] [blame] | 133 | else if(typeof component == 'object') |
| 134 | // Assume component is a byte array. We can't check instanceof Array because |
| 135 | // this doesn't work in JavaScript if the array comes from a different module. |
| 136 | result = new Uint8Array(component); |
Jeff Thompson | 87021f7 | 2012-11-18 17:40:06 -0800 | [diff] [blame] | 137 | else |
Jeff Thompson | 9ab151a | 2012-11-24 21:22:30 -0800 | [diff] [blame] | 138 | throw new Error("Cannot add Name element at index " + this.components.length + |
| 139 | ": Invalid type"); |
Jeff Thompson | 87021f7 | 2012-11-18 17:40:06 -0800 | [diff] [blame] | 140 | |
| 141 | return this.components.push(result); |
Meki Cherkaoui | f441d3a | 2012-04-22 15:17:52 -0700 | [diff] [blame] | 142 | }; |
| 143 | |
Jeff Thompson | bd82926 | 2012-11-30 22:28:37 -0800 | [diff] [blame] | 144 | // Return the escaped name string according to "CCNx URI Scheme". |
Jeff Thompson | 4e8b770 | 2012-10-21 23:42:27 -0700 | [diff] [blame] | 145 | Name.prototype.to_uri = function() { |
Jeff Thompson | 9530663 | 2013-01-23 19:20:37 -0800 | [diff] [blame] | 146 | if (this.components.length == 0) |
| 147 | return "/"; |
| 148 | |
Jeff Thompson | 4e8b770 | 2012-10-21 23:42:27 -0700 | [diff] [blame] | 149 | var result = ""; |
| 150 | |
| 151 | for(var i = 0; i < this.components.length; ++i) |
| 152 | result += "/"+ Name.toEscapedString(this.components[i]); |
| 153 | |
| 154 | return result; |
| 155 | }; |
| 156 | |
Jeff Thompson | 87021f7 | 2012-11-18 17:40:06 -0800 | [diff] [blame] | 157 | /* |
| 158 | * Return a new Name with the first nComponents components of this Name. |
| 159 | */ |
| 160 | Name.prototype.getPrefix = function(nComponents) { |
| 161 | return new Name(this.components.slice(0, nComponents)); |
| 162 | } |
| 163 | |
| 164 | /* |
| 165 | * Return a new ArrayBuffer of the component at i. |
| 166 | */ |
| 167 | Name.prototype.getComponent = function(i) { |
| 168 | var result = new ArrayBuffer(this.components[i].length); |
| 169 | new Uint8Array(result).set(this.components[i]); |
| 170 | return result; |
| 171 | } |
| 172 | |
Jeff Thompson | 16a35f7 | 2012-11-25 08:07:33 -0800 | [diff] [blame] | 173 | /* |
| 174 | * The "file name" in a name is the last component that isn't blank and doesn't start with one of the |
| 175 | * special marker octets (for version, etc.). Return the index in this.components of |
| 176 | * the file name, or -1 if not found. |
| 177 | */ |
| 178 | Name.prototype.indexOfFileName = function() { |
| 179 | for (var i = this.components.length - 1; i >= 0; --i) { |
| 180 | var component = this.components[i]; |
| 181 | if (component.length <= 0) |
| 182 | continue; |
| 183 | |
| 184 | if (component[0] == 0 || component[0] == 0xC0 || component[0] == 0xC1 || |
| 185 | (component[0] >= 0xF5 && component[0] <= 0xFF)) |
| 186 | continue; |
| 187 | |
| 188 | return i; |
| 189 | } |
| 190 | |
| 191 | return -1; |
| 192 | } |
| 193 | |
Jeff Thompson | 990e300 | 2012-12-02 23:29:36 -0800 | [diff] [blame] | 194 | /* |
Jeff Thompson | 77fc9b7 | 2012-12-16 12:38:09 -0800 | [diff] [blame] | 195 | * Return true if this Name has the same components as name. |
| 196 | */ |
| 197 | Name.prototype.equalsName = function(name) { |
| 198 | if (this.components.length != name.components.length) |
| 199 | return false; |
| 200 | |
| 201 | // Start from the last component because they are more likely to differ. |
| 202 | for (var i = this.components.length - 1; i >= 0; --i) { |
| 203 | if (!DataUtils.arraysEqual(this.components[i], name.components[i])) |
| 204 | return false; |
| 205 | } |
| 206 | |
| 207 | return true; |
| 208 | } |
| 209 | |
| 210 | /* |
Jeff Thompson | 990e300 | 2012-12-02 23:29:36 -0800 | [diff] [blame] | 211 | * Find the last component in name that has a ContentDigest and return the digest value as Uint8Array, |
Jeff Thompson | ac3e62c | 2012-12-16 19:39:58 -0800 | [diff] [blame] | 212 | * or null if not found. See Name.getComponentContentDigestValue. |
Jeff Thompson | 990e300 | 2012-12-02 23:29:36 -0800 | [diff] [blame] | 213 | */ |
| 214 | Name.prototype.getContentDigestValue = function() { |
Jeff Thompson | 990e300 | 2012-12-02 23:29:36 -0800 | [diff] [blame] | 215 | for (var i = this.components.length - 1; i >= 0; --i) { |
Jeff Thompson | ac3e62c | 2012-12-16 19:39:58 -0800 | [diff] [blame] | 216 | var digestValue = Name.getComponentContentDigestValue(this.components[i]); |
| 217 | if (digestValue != null) |
| 218 | return digestValue; |
Jeff Thompson | 990e300 | 2012-12-02 23:29:36 -0800 | [diff] [blame] | 219 | } |
| 220 | |
| 221 | return null; |
| 222 | } |
| 223 | |
Jeff Thompson | ac3e62c | 2012-12-16 19:39:58 -0800 | [diff] [blame] | 224 | /* |
| 225 | * If component is a ContentDigest, return the digest value as a Uint8Array subarray (don't modify!). |
| 226 | * If not a ContentDigest, return null. |
| 227 | * A ContentDigest component is Name.ContentDigestPrefix + 32 bytes + Name.ContentDigestSuffix. |
| 228 | */ |
| 229 | Name.getComponentContentDigestValue = function(component) { |
| 230 | var digestComponentLength = Name.ContentDigestPrefix.length + 32 + Name.ContentDigestSuffix.length; |
| 231 | // Check for the correct length and equal ContentDigestPrefix and ContentDigestSuffix. |
| 232 | if (component.length == digestComponentLength && |
| 233 | DataUtils.arraysEqual(component.subarray(0, Name.ContentDigestPrefix.length), |
| 234 | Name.ContentDigestPrefix) && |
| 235 | DataUtils.arraysEqual(component.subarray |
| 236 | (component.length - Name.ContentDigestSuffix.length, component.length), |
| 237 | Name.ContentDigestSuffix)) |
| 238 | return component.subarray(Name.ContentDigestPrefix.length, Name.ContentDigestPrefix.length + 32); |
| 239 | else |
| 240 | return null; |
| 241 | } |
| 242 | |
Jeff Thompson | 990e300 | 2012-12-02 23:29:36 -0800 | [diff] [blame] | 243 | // Meta GUID "%C1.M.G%C1" + ContentDigest with a 32 byte BLOB. |
| 244 | Name.ContentDigestPrefix = new Uint8Array([0xc1, 0x2e, 0x4d, 0x2e, 0x47, 0xc1, 0x01, 0xaa, 0x02, 0x85]); |
| 245 | Name.ContentDigestSuffix = new Uint8Array([0x00]); |
| 246 | |
Jeff Thompson | 78849a7 | 2013-02-03 22:35:54 -0800 | [diff] [blame] | 247 | /* |
Jeff Thompson | 4e8b770 | 2012-10-21 23:42:27 -0700 | [diff] [blame] | 248 | * Return component as an escaped string according to "CCNx URI Scheme". |
| 249 | * We can't use encodeURIComponent because that doesn't encode all the characters we want to. |
| 250 | */ |
| 251 | Name.toEscapedString = function(component) { |
| 252 | var result = ""; |
| 253 | var gotNonDot = false; |
| 254 | for (var i = 0; i < component.length; ++i) { |
| 255 | if (component[i] != 0x2e) { |
| 256 | gotNonDot = true; |
| 257 | break; |
| 258 | } |
| 259 | } |
| 260 | if (!gotNonDot) { |
| 261 | // Special case for component of zero or more periods. Add 3 periods. |
| 262 | result = "..."; |
| 263 | for (var i = 0; i < component.length; ++i) |
| 264 | result += "."; |
| 265 | } |
| 266 | else { |
| 267 | for (var i = 0; i < component.length; ++i) { |
| 268 | var value = component[i]; |
| 269 | // Check for 0-9, A-Z, a-z, (+), (-), (.), (_) |
| 270 | if (value >= 0x30 && value <= 0x39 || value >= 0x41 && value <= 0x5a || |
| 271 | value >= 0x61 && value <= 0x7a || value == 0x2b || value == 0x2d || |
| 272 | value == 0x2e || value == 0x5f) |
| 273 | result += String.fromCharCode(value); |
| 274 | else |
| 275 | result += "%" + (value < 16 ? "0" : "") + value.toString(16).toUpperCase(); |
| 276 | } |
| 277 | } |
| 278 | return result; |
| 279 | }; |
Wentao Shang | b42483a | 2013-01-03 15:32:32 -0800 | [diff] [blame] | 280 | |
Jeff Thompson | 78849a7 | 2013-02-03 22:35:54 -0800 | [diff] [blame] | 281 | /* |
| 282 | * Return component as a Uint8Array by decoding the escapedString according to "CCNx URI Scheme". |
| 283 | * If escapedString is "", "." or ".." then return null, which means to skip the component in the name. |
| 284 | */ |
| 285 | Name.fromEscapedString = function(escapedString) { |
| 286 | var component = unescape(escapedString.trim()); |
| 287 | |
| 288 | if (component.match(/[^.]/) == null) { |
| 289 | // Special case for component of only periods. |
| 290 | if (component.length <= 2) |
| 291 | // Zero, one or two periods is illegal. Ignore this componenent to be |
| 292 | // consistent with the C implementation. |
| 293 | return null; |
| 294 | else |
| 295 | // Remove 3 periods. |
| 296 | return DataUtils.toNumbersFromString(component.substr(3, component.length - 3)); |
| 297 | } |
| 298 | else |
| 299 | return DataUtils.toNumbersFromString(component); |
| 300 | } |
| 301 | |
Wentao Shang | b42483a | 2013-01-03 15:32:32 -0800 | [diff] [blame] | 302 | Name.prototype.match = function(/*Name*/ name) { |
| 303 | var i_name = this.components; |
| 304 | var o_name = name.components; |
| 305 | |
| 306 | // The intrest name is longer than the name we are checking it against. |
| 307 | if (i_name.length > o_name.length) |
| 308 | return false; |
| 309 | |
| 310 | // Check if at least one of given components doesn't match. |
| 311 | for (var i = 0; i < i_name.length; ++i) { |
| 312 | if (!DataUtils.arraysEqual(i_name[i], o_name[i])) |
| 313 | return false; |
| 314 | } |
| 315 | |
| 316 | return true; |
| 317 | }; |