blob: 99732885bdad942207884c71055547a98d561ba1 [file] [log] [blame]
Jeff Thompson08ab3cd2012-10-08 02:56:20 -07001/*
Jeff Thompson17a9da82012-11-12 01:11:01 -08002 * @author: Jeff Thompson
Jeff Thompson745026e2012-10-13 12:49:20 -07003 * See COPYING for copyright and distribution information.
Jeff Thompsonbd829262012-11-30 22:28:37 -08004 * This is the ndn protocol handler.
Jeff Thompson08ab3cd2012-10-08 02:56:20 -07005 * Protocol handling code derived from http://mike.kaply.com/2011/01/18/writing-a-firefox-protocol-handler/
6 */
7
8const Cc = Components.classes;
9const Ci = Components.interfaces;
10const Cr = Components.results;
11
12const nsIProtocolHandler = Ci.nsIProtocolHandler;
13
14Components.utils.import("resource://gre/modules/XPCOMUtils.jsm");
15Components.utils.import("chrome://modules/content/ndn-js.jsm");
16Components.utils.import("chrome://modules/content/ContentChannel.jsm");
Jeff Thompson6ad5c362012-12-27 17:57:02 -080017Components.utils.import("chrome://modules/content/NdnProtocolInfo.jsm");
Jeff Thompson08ab3cd2012-10-08 02:56:20 -070018
Jeff Thompson74d38e32013-03-18 21:44:07 -070019function NdnProtocol() {
Jeff Thompson08ab3cd2012-10-08 02:56:20 -070020}
21
Jeff Thompsonbd829262012-11-30 22:28:37 -080022NdnProtocol.prototype = {
23 scheme: "ndn",
Jeff Thompson9e6dff02012-11-04 09:20:47 -080024 protocolFlags: nsIProtocolHandler.URI_NORELATIVE |
Jeff Thompson08ab3cd2012-10-08 02:56:20 -070025 nsIProtocolHandler.URI_NOAUTH |
26 nsIProtocolHandler.URI_LOADABLE_BY_ANYONE,
27
Jeff Thompson9e6dff02012-11-04 09:20:47 -080028 newURI: function(aSpec, aOriginCharset, aBaseURI)
29 {
Jeff Thompson2cc54b42013-01-12 23:11:12 -080030 var uri = Cc["@mozilla.org/network/simple-uri;1"].createInstance(Ci.nsIURI);
31
Jeff Thompsond6b61e42012-11-24 12:10:35 -080032 // We have to trim now because nsIURI converts spaces to %20 and we can't trim in newChannel.
Jeff Thompsonb2f91ea2013-01-13 15:59:26 -080033 var uriParts = NdnProtocolInfo.splitUri(aSpec);
Jeff Thompson2cc54b42013-01-12 23:11:12 -080034 if (aBaseURI == null || uriParts.name.length < 1 || uriParts.name[0] == '/')
35 // Just reconstruct the trimmed URI.
36 uri.spec = "ndn:" + uriParts.name + uriParts.search + uriParts.hash;
37 else {
38 // Make a URI relative to the base name up to the file name component.
Jeff Thompsonb2f91ea2013-01-13 15:59:26 -080039 var baseUriParts = NdnProtocolInfo.splitUri(aBaseURI.spec);
Jeff Thompson2cc54b42013-01-12 23:11:12 -080040 var baseName = new Name(baseUriParts.name);
41 var iFileName = baseName.indexOfFileName();
42
43 var relativeName = uriParts.name;
44 // Handle ../
45 while (true) {
46 if (relativeName.substr(0, 2) == "./")
47 relativeName = relativeName.substr(2);
48 else if (relativeName.substr(0, 3) == "../") {
49 relativeName = relativeName.substr(3);
50 if (iFileName > 0)
51 --iFileName;
52 }
53 else
54 break;
55 }
56
57 var prefixUri = "/";
58 if (iFileName > 0)
59 prefixUri = new Name(baseName.components.slice(0, iFileName)).to_uri() + "/";
60 uri.spec = "ndn:" + prefixUri + relativeName + uriParts.search + uriParts.hash;
61 }
62
Jeff Thompson9e6dff02012-11-04 09:20:47 -080063 return uri;
64 },
Jeff Thompson08ab3cd2012-10-08 02:56:20 -070065
Jeff Thompson9e6dff02012-11-04 09:20:47 -080066 newChannel: function(aURI)
67 {
Jeff Thompson1eea6322012-11-23 16:56:18 -080068 try {
Jeff Thompsonb2f91ea2013-01-13 15:59:26 -080069 var uriParts = NdnProtocolInfo.splitUri(aURI.spec);
Jeff Thompsondf0a6f72012-10-21 15:58:58 -070070
Jeff Thompson5fc9b672012-11-24 10:00:56 -080071 var template = new Interest(new Name([]));
72 // Use the same default as NDN.expressInterest.
Jeff Thompson42806a12012-12-29 18:19:39 -080073 template.interestLifetime = 4000; // milliseconds
Jeff Thompson8107ec82013-01-12 21:53:27 -080074 var searchWithoutNdn = extractNdnSearch(uriParts.search, template);
Jeff Thompsone5a88282013-01-05 21:02:06 -080075
76 var segmentTemplate = new Interest(new Name([]));
77 // Only use the interest selectors which make sense for fetching further segments.
78 segmentTemplate.publisherPublicKeyDigest = template.publisherPublicKeyDigest;
79 segmentTemplate.scope = template.scope;
80 segmentTemplate.interestLifetime = template.interestLifetime;
Jeff Thompson5fc9b672012-11-24 10:00:56 -080081
Jeff Thompson1eea6322012-11-23 16:56:18 -080082 var requestContent = function(contentListener) {
Jeff Thompson8107ec82013-01-12 21:53:27 -080083 var name = new Name(uriParts.name);
Jeff Thompson3d6ce942012-12-16 12:11:42 -080084 // Use the same NDN object each time.
Jeff Thompson4eb992a2013-03-09 21:05:53 -080085 NdnProtocolInfo.ndn.expressInterest(name, new ExponentialReExpressClosure
86 (new ContentClosure(NdnProtocolInfo.ndn, contentListener, name,
Jeff Thompson52843b12013-02-18 17:53:18 -080087 aURI, searchWithoutNdn + uriParts.hash, segmentTemplate)),
Jeff Thompson5fc9b672012-11-24 10:00:56 -080088 template);
Jeff Thompson9e6dff02012-11-04 09:20:47 -080089 };
Jeff Thompson57d07382012-10-29 23:25:54 -070090
Jeff Thompson5fc9b672012-11-24 10:00:56 -080091 return new ContentChannel(aURI, requestContent);
Jeff Thompson9e6dff02012-11-04 09:20:47 -080092 } catch (ex) {
Jeff Thompsonbd829262012-11-30 22:28:37 -080093 dump("NdnProtocol.newChannel exception: " + ex + "\n" + ex.stack);
Jeff Thompson9e6dff02012-11-04 09:20:47 -080094 }
95 },
Jeff Thompson08ab3cd2012-10-08 02:56:20 -070096
Jeff Thompsonbd829262012-11-30 22:28:37 -080097 classDescription: "ndn Protocol Handler",
98 contractID: "@mozilla.org/network/protocol;1?name=" + "ndn",
Jeff Thompson9e6dff02012-11-04 09:20:47 -080099 classID: Components.ID('{8122e660-1012-11e2-892e-0800200c9a66}'),
100 QueryInterface: XPCOMUtils.generateQI([Ci.nsIProtocolHandler])
Jeff Thompson3d6ce942012-12-16 12:11:42 -0800101};
Jeff Thompson08ab3cd2012-10-08 02:56:20 -0700102
103if (XPCOMUtils.generateNSGetFactory)
Jeff Thompsonbd829262012-11-30 22:28:37 -0800104 var NSGetFactory = XPCOMUtils.generateNSGetFactory([NdnProtocol]);
Jeff Thompson08ab3cd2012-10-08 02:56:20 -0700105else
Jeff Thompsonbd829262012-11-30 22:28:37 -0800106 var NSGetModule = XPCOMUtils.generateNSGetModule([NdnProtocol]);
Jeff Thompson9e6dff02012-11-04 09:20:47 -0800107
108/*
109 * Create a closure for calling expressInterest.
110 * contentListener is from the call to requestContent.
Jeff Thompson4a4caba2013-02-28 21:31:33 -0800111 * uriName is the name in the URI passed to newChannel (used in part to determine whether to request
112 * only that segment number and for updating the URL bar).
Jeff Thompson3663c672013-02-04 23:22:11 -0800113 * aURI is the URI passed to newChannel.
Jeff Thompson1eea6322012-11-23 16:56:18 -0800114 * uriSearchAndHash is the search and hash part of the URI passed to newChannel, including the '?'
115 * and/or '#' but without the interest selector fields.
Jeff Thompsone5a88282013-01-05 21:02:06 -0800116 * segmentTemplate is the template used in expressInterest to fetch further segments.
Jeff Thompson52843b12013-02-18 17:53:18 -0800117 * The uses ExponentialReExpressClosure in expressInterest to re-express if fetching a segment times out.
Jeff Thompson9e6dff02012-11-04 09:20:47 -0800118 */
119var ContentClosure = function ContentClosure
Jeff Thompson4a4caba2013-02-28 21:31:33 -0800120 (ndn, contentListener, uriName, aURI, uriSearchAndHash, segmentTemplate) {
Jeff Thompson9e6dff02012-11-04 09:20:47 -0800121 // Inherit from Closure.
122 Closure.call(this);
123
124 this.ndn = ndn;
125 this.contentListener = contentListener;
Jeff Thompson4a4caba2013-02-28 21:31:33 -0800126 this.uriName = uriName;
Jeff Thompson3663c672013-02-04 23:22:11 -0800127 this.aURI = aURI;
Jeff Thompson1eea6322012-11-23 16:56:18 -0800128 this.uriSearchAndHash = uriSearchAndHash;
Jeff Thompsone5a88282013-01-05 21:02:06 -0800129 this.segmentTemplate = segmentTemplate;
Jeff Thompson1eea6322012-11-23 16:56:18 -0800130
Jeff Thompsonf6995b52013-01-23 21:21:16 -0800131 this.segmentStore = new SegmentStore();
Jeff Thompson74d38e32013-03-18 21:44:07 -0700132 this.contentSha256 = Cc["@mozilla.org/security/hash;1"].createInstance(Ci.nsICryptoHash);
133 this.contentSha256.init(this.contentSha256.SHA256);
Jeff Thompsonf6995b52013-01-23 21:21:16 -0800134 this.didRequestFinalSegment = false;
135 this.finalSegmentNumber = null;
Jeff Thompson52843b12013-02-18 17:53:18 -0800136 this.didOnStart = false;
Jeff Thompson4a4caba2013-02-28 21:31:33 -0800137 this.uriEndsWithSegmentNumber = endsWithSegmentNumber(uriName);
Jeff Thompson7fb08bf2013-03-15 00:13:10 -0700138 this.nameWithoutSegment = null;
Jeff Thompson9c7d6912013-03-15 00:53:27 -0700139 this.excludedMetaComponents = [];
140 this.iMetaComponent = null;
Jeff Thompson3d6ce942012-12-16 12:11:42 -0800141};
Jeff Thompson9e6dff02012-11-04 09:20:47 -0800142
143ContentClosure.prototype.upcall = function(kind, upcallInfo) {
Jeff Thompsonf6995b52013-01-23 21:21:16 -0800144 try {
Jeff Thompson3663c672013-02-04 23:22:11 -0800145 if (this.contentListener.done)
146 // We are getting unexpected extra results.
147 return Closure.RESULT_ERR;
148
149 if (kind == Closure.UPCALL_INTEREST_TIMED_OUT) {
Jeff Thompson152342b2013-02-18 20:36:53 -0800150 if (!this.didOnStart) {
Jeff Thompson7e2e2e22013-03-10 16:41:37 -0700151 // We have not received a segment to start the content yet, so assume the URI can't be fetched.
Jeff Thompson3663c672013-02-04 23:22:11 -0800152 this.contentListener.onStart("text/plain", "utf-8", this.aURI);
153 this.contentListener.onReceivedContent
Jeff Thompson152342b2013-02-18 20:36:53 -0800154 ("The latest interest timed out after " + upcallInfo.interest.interestLifetime + " milliseconds.");
Jeff Thompson3663c672013-02-04 23:22:11 -0800155 this.contentListener.onStop();
156 return Closure.RESULT_OK;
157 }
158 else
Jeff Thompson52843b12013-02-18 17:53:18 -0800159 // ExponentialReExpressClosure already tried to re-express, so quit.
Jeff Thompson3663c672013-02-04 23:22:11 -0800160 return Closure.RESULT_ERR;
161 }
162
Jeff Thompson9e6dff02012-11-04 09:20:47 -0800163 if (!(kind == Closure.UPCALL_CONTENT ||
164 kind == Closure.UPCALL_CONTENT_UNVERIFIED))
165 // The upcall is not for us.
166 return Closure.RESULT_ERR;
167
168 var contentObject = upcallInfo.contentObject;
169 if (contentObject.content == null) {
Jeff Thompsonbd829262012-11-30 22:28:37 -0800170 dump("NdnProtocol.ContentClosure: contentObject.content is null\n");
Jeff Thompson9e6dff02012-11-04 09:20:47 -0800171 return Closure.RESULT_ERR;
172 }
Jeff Thompson6ad5c362012-12-27 17:57:02 -0800173
Jeff Thompson7e2e2e22013-03-10 16:41:37 -0700174 // Assume this is only called once we're connected, report the host and port.
175 NdnProtocolInfo.setConnectedNdnHub(this.ndn.host, this.ndn.port);
176
Jeff Thompson9e6dff02012-11-04 09:20:47 -0800177 // If !this.uriEndsWithSegmentNumber, we use the segmentNumber to load multiple segments.
Jeff Thompsonf6995b52013-01-23 21:21:16 -0800178 // If this.uriEndsWithSegmentNumber, then we leave segmentNumber null.
Jeff Thompson9e6dff02012-11-04 09:20:47 -0800179 var segmentNumber = null;
Jeff Thompson7fb08bf2013-03-15 00:13:10 -0700180 if (!this.uriEndsWithSegmentNumber && endsWithSegmentNumber(contentObject.name))
Jeff Thompson9e6dff02012-11-04 09:20:47 -0800181 segmentNumber = DataUtils.bigEndianToUnsignedInt
182 (contentObject.name.components[contentObject.name.components.length - 1]);
Jeff Thompson9e6dff02012-11-04 09:20:47 -0800183
Jeff Thompson52843b12013-02-18 17:53:18 -0800184 if ((segmentNumber == null || segmentNumber == 0) && !this.didOnStart) {
Jeff Thompson4a4caba2013-02-28 21:31:33 -0800185 // This is the first or only segment.
Jeff Thompson4a4caba2013-02-28 21:31:33 -0800186 var iMetaComponent = getIndexOfMetaComponent(contentObject.name);
187 if (!this.uriEndsWithSegmentNumber && iMetaComponent >= 0 &&
188 getIndexOfMetaComponent(this.uriName) < 0) {
Jeff Thompson7fb08bf2013-03-15 00:13:10 -0700189 // The matched content name has a META component that wasn't requested in the original
190 // URI. Add this to the excluded META components to try to get the "real" content.
Jeff Thompson4a4caba2013-02-28 21:31:33 -0800191 var nameWithoutMeta = new Name(contentObject.name.components.slice(0, iMetaComponent));
Jeff Thompson9c7d6912013-03-15 00:53:27 -0700192 if (this.excludedMetaComponents.length > 0 && iMetaComponent != this.iMetaComponent)
193 // We are excluding META components at a new position in the name, so start over.
194 this.excludedMetaComponents = [];
195 this.iMetaComponent = iMetaComponent;
196 this.excludedMetaComponents.push(contentObject.name.components[iMetaComponent]);
197 // Exclude components are required to be sorted.
198 this.excludedMetaComponents.sort(Exclude.compareComponents);
Jeff Thompson4a4caba2013-02-28 21:31:33 -0800199
Jeff Thompson9c7d6912013-03-15 00:53:27 -0700200 var excludeMetaTemplate = this.segmentTemplate.clone();
201 excludeMetaTemplate.exclude = new Exclude(this.excludedMetaComponents);
Jeff Thompson4a4caba2013-02-28 21:31:33 -0800202 this.ndn.expressInterest
203 (nameWithoutMeta, new ExponentialReExpressClosure(this), excludeMetaTemplate);
Jeff Thompson7fb08bf2013-03-15 00:13:10 -0700204 return Closure.RESULT_OK;
Jeff Thompson4a4caba2013-02-28 21:31:33 -0800205 }
Jeff Thompson4a4caba2013-02-28 21:31:33 -0800206
Jeff Thompson52843b12013-02-18 17:53:18 -0800207 this.didOnStart = true;
208
Jeff Thompson9e6dff02012-11-04 09:20:47 -0800209 // Get the URI from the ContentObject including the version.
210 var contentUriSpec;
211 if (!this.uriEndsWithSegmentNumber && endsWithSegmentNumber(contentObject.name)) {
212 var nameWithoutSegmentNumber = new Name
Jeff Thompson963d2da2012-12-02 23:31:22 -0800213 (contentObject.name.components.slice(0, contentObject.name.components.length - 1));
Jeff Thompsonbd829262012-11-30 22:28:37 -0800214 contentUriSpec = "ndn:" + nameWithoutSegmentNumber.to_uri();
Jeff Thompson9e6dff02012-11-04 09:20:47 -0800215 }
216 else
Jeff Thompsonbd829262012-11-30 22:28:37 -0800217 contentUriSpec = "ndn:" + contentObject.name.to_uri();
Jeff Thompson9e6dff02012-11-04 09:20:47 -0800218
Jeff Thompson1eea6322012-11-23 16:56:18 -0800219 // Include the search and hash.
220 contentUriSpec += this.uriSearchAndHash;
221
Jeff Thompsone769c512012-11-04 17:25:07 -0800222 var contentTypeEtc = getNameContentTypeAndCharset(contentObject.name);
Jeff Thompson9e6dff02012-11-04 09:20:47 -0800223 var ioService = Cc["@mozilla.org/network/io-service;1"].getService(Ci.nsIIOService);
224 this.contentListener.onStart(contentTypeEtc.contentType, contentTypeEtc.contentCharset,
Jeff Thompson3663c672013-02-04 23:22:11 -0800225 ioService.newURI(contentUriSpec, this.aURI.originCharset, null));
Jeff Thompson9e6dff02012-11-04 09:20:47 -0800226
Jeff Thompson7fb08bf2013-03-15 00:13:10 -0700227 if (segmentNumber == null) {
228 // We are not doing segments, so just finish.
229 this.contentListener.onReceivedContent(DataUtils.toString(contentObject.content));
Jeff Thompson74d38e32013-03-18 21:44:07 -0700230 this.contentSha256.update(contentObject.content, contentObject.content.length);
Jeff Thompson7fb08bf2013-03-15 00:13:10 -0700231 this.contentListener.onStop();
Jeff Thompsonf6995b52013-01-23 21:21:16 -0800232
Jeff Thompson7fb08bf2013-03-15 00:13:10 -0700233 if (!this.uriEndsWithSegmentNumber) {
234 var nameContentDigest = contentObject.name.getContentDigestValue();
Jeff Thompsondd038fc2013-03-16 16:29:47 -0700235 if (nameContentDigest != null && this.contentSha256 != null &&
Jeff Thompson74d38e32013-03-18 21:44:07 -0700236 !DataUtils.arraysEqual(nameContentDigest,
237 DataUtils.toNumbersFromString(this.contentSha256.finish(false))))
Jeff Thompson7fb08bf2013-03-15 00:13:10 -0700238 // TODO: How to show the user an error for invalid digest?
Jeff Thompson74d38e32013-03-18 21:44:07 -0700239 dump("Content does not match digest in name " + contentObject.name.to_uri() + "\n");
Jeff Thompson7fb08bf2013-03-15 00:13:10 -0700240 }
241 return Closure.RESULT_OK;
Jeff Thompsonf6995b52013-01-23 21:21:16 -0800242 }
Jeff Thompson7fb08bf2013-03-15 00:13:10 -0700243 else
244 // We are doing segments. Make sure we always request the same base name.
245 this.nameWithoutSegment = new Name(contentObject.name.components.slice
246 (0, contentObject.name.components.length - 1));
Jeff Thompsonf6995b52013-01-23 21:21:16 -0800247 }
248
Jeff Thompson7fb08bf2013-03-15 00:13:10 -0700249 if (segmentNumber == null)
250 // We should be doing segments at this point.
251 return Closure.RESULT_ERR;
252
253 if (!(contentObject.name.components.length == this.nameWithoutSegment.components.length + 1 &&
254 this.nameWithoutSegment.match(contentObject.name)))
255 // The content object name is not part of our sequence of segments.
256 return Closure.RESULT_ERR;
257
258 this.segmentStore.storeContent(segmentNumber, contentObject);
259
Jeff Thompsonf6995b52013-01-23 21:21:16 -0800260 if (contentObject.signedInfo != null && contentObject.signedInfo.finalBlockID != null)
261 this.finalSegmentNumber = DataUtils.bigEndianToUnsignedInt(contentObject.signedInfo.finalBlockID);
262
263 // The content was already put in the store. Retrieve as much as possible.
264 var entry;
265 while ((entry = this.segmentStore.maybeRetrieveNextEntry()) != null) {
266 segmentNumber = entry.key;
267 contentObject = entry.value;
268 this.contentListener.onReceivedContent(DataUtils.toString(contentObject.content));
Jeff Thompson74d38e32013-03-18 21:44:07 -0700269 this.contentSha256.update(contentObject.content, contentObject.content.length);
Jeff Thompsonf6995b52013-01-23 21:21:16 -0800270
271 if (this.finalSegmentNumber != null && segmentNumber == this.finalSegmentNumber) {
272 // Finished.
273 this.contentListener.onStop();
274 var nameContentDigest = contentObject.name.getContentDigestValue();
Jeff Thompsondd038fc2013-03-16 16:29:47 -0700275 if (nameContentDigest != null && this.contentSha256 != null &&
Jeff Thompson74d38e32013-03-18 21:44:07 -0700276 !DataUtils.arraysEqual(nameContentDigest,
277 DataUtils.toNumbersFromString(this.contentSha256.finish(false))))
Jeff Thompsonf6995b52013-01-23 21:21:16 -0800278 // TODO: How to show the user an error for invalid digest?
Jeff Thompson74d38e32013-03-18 21:44:07 -0700279 dump("Content does not match digest in name " + contentObject.name.to_uri() + "\n");
Jeff Thompsonf6995b52013-01-23 21:21:16 -0800280
281 return Closure.RESULT_OK;
282 }
Jeff Thompson9e6dff02012-11-04 09:20:47 -0800283 }
284
Jeff Thompsonf6995b52013-01-23 21:21:16 -0800285 if (this.finalSegmentNumber == null && !this.didRequestFinalSegment) {
Jeff Thompsonb083c8e2013-01-23 21:27:32 -0800286 this.didRequestFinalSegment = true;
Jeff Thompsonf6995b52013-01-23 21:21:16 -0800287 // Try to determine the final segment now.
Jeff Thompson4a4caba2013-02-28 21:31:33 -0800288 // Clone the template to set the childSelector.
289 var childSelectorTemplate = this.segmentTemplate.clone();
290 childSelectorTemplate.childSelector = 1;
Jeff Thompson52843b12013-02-18 17:53:18 -0800291 this.ndn.expressInterest
Jeff Thompson7fb08bf2013-03-15 00:13:10 -0700292 (this.nameWithoutSegment, new ExponentialReExpressClosure(this), childSelectorTemplate);
Jeff Thompsonf6995b52013-01-23 21:21:16 -0800293 }
294
295 // Request new segments.
296 var toRequest = this.segmentStore.requestSegmentNumbers(2);
297 for (var i = 0; i < toRequest.length; ++i) {
298 if (this.finalSegmentNumber != null && toRequest[i] > this.finalSegmentNumber)
299 continue;
300
Jeff Thompson52843b12013-02-18 17:53:18 -0800301 this.ndn.expressInterest
Jeff Thompson7fb08bf2013-03-15 00:13:10 -0700302 (new Name(this.nameWithoutSegment).addSegment(toRequest[i]),
Jeff Thompsonca2535c2013-02-28 22:26:13 -0800303 new ExponentialReExpressClosure(this), this.segmentTemplate);
Jeff Thompson9e6dff02012-11-04 09:20:47 -0800304 }
Jeff Thompson9e6dff02012-11-04 09:20:47 -0800305
306 return Closure.RESULT_OK;
Jeff Thompsonf6995b52013-01-23 21:21:16 -0800307 } catch (ex) {
308 dump("ContentClosure.upcall exception: " + ex + "\n" + ex.stack);
309 return Closure.RESULT_ERR;
310 }
Jeff Thompson9e6dff02012-11-04 09:20:47 -0800311};
Jeff Thompsonf6995b52013-01-23 21:21:16 -0800312
313/*
314 * A SegmentStore stores segments until they are retrieved in order starting with segment 0.
315 */
316var SegmentStore = function SegmentStore() {
317 // Each entry is an object where the key is the segment number and value is null if
318 // the segment number is requested or the contentObject if received.
319 this.store = new SortedArray();
320 this.maxRetrievedSegmentNumber = -1;
321};
322
323SegmentStore.prototype.storeContent = function(segmentNumber, contentObject) {
324 // We don't expect to try to store a segment that has already been retrieved, but check anyway.
325 if (segmentNumber > this.maxRetrievedSegmentNumber)
326 this.store.set(segmentNumber, contentObject);
327};
328
329/*
330 * If the min segment number is this.maxRetrievedSegmentNumber + 1 and its value is not null,
331 * then delete from the store, return the entry with key and value, and update maxRetrievedSegmentNumber.
332 * Otherwise return null.
333 */
334SegmentStore.prototype.maybeRetrieveNextEntry = function() {
335 if (this.store.entries.length > 0 && this.store.entries[0].value != null &&
336 this.store.entries[0].key == this.maxRetrievedSegmentNumber + 1) {
337 var entry = this.store.entries[0];
338 this.store.removeAt(0);
339 ++this.maxRetrievedSegmentNumber;
340 return entry;
341 }
342 else
343 return null;
344};
345
346/*
347 * Return an array of the next segment numbers that need to be requested so that the total
348 * requested segments is totalRequestedSegments. If a segment store entry value is null, it is
349 * already requested and is not returned. If a segment number is returned, create a
350 * entry in the segment store with a null value.
351 */
352SegmentStore.prototype.requestSegmentNumbers = function(totalRequestedSegments) {
353 // First, count how many are already requested.
354 var nRequestedSegments = 0;
355 for (var i = 0; i < this.store.entries.length; ++i) {
356 if (this.store.entries[i].value == null) {
357 ++nRequestedSegments;
358 if (nRequestedSegments >= totalRequestedSegments)
359 // Already maxed out on requests.
360 return [];
361 }
362 }
363
364 var toRequest = [];
365 var nextSegmentNumber = this.maxRetrievedSegmentNumber + 1;
366 for (var i = 0; i < this.store.entries.length; ++i) {
367 var entry = this.store.entries[i];
368 // Fill in the gap before the segment number in the entry.
369 while (nextSegmentNumber < entry.key) {
370 toRequest.push(nextSegmentNumber);
371 ++nextSegmentNumber;
372 ++nRequestedSegments;
373 if (nRequestedSegments >= totalRequestedSegments)
374 break;
375 }
376 if (nRequestedSegments >= totalRequestedSegments)
377 break;
378
379 nextSegmentNumber = entry.key + 1;
380 }
381
382 // We already filled in the gaps for the segments in the store. Continue after the last.
383 while (nRequestedSegments < totalRequestedSegments) {
384 toRequest.push(nextSegmentNumber);
385 ++nextSegmentNumber;
386 ++nRequestedSegments;
387 }
388
389 // Mark the new segment numbers as requested.
390 for (var i = 0; i < toRequest.length; ++i)
391 this.store.set(toRequest[i], null);
392 return toRequest;
393}
394
395/*
396 * A SortedArray is an array of objects with key and value, where the key is an integer.
397 */
398var SortedArray = function SortedArray() {
399 this.entries = [];
400}
401
402SortedArray.prototype.sortEntries = function() {
403 this.entries.sort(function(a, b) { return a.key - b.key; });
404};
405
406SortedArray.prototype.indexOfKey = function(key) {
407 for (var i = 0; i < this.entries.length; ++i) {
408 if (this.entries[i].key == key)
409 return i;
410 }
411
412 return -1;
413}
414
415SortedArray.prototype.set = function(key, value) {
416 var i = this.indexOfKey(key);
417 if (i >= 0) {
418 this.entries[i].value = value;
419 return;
420 }
421
422 this.entries.push({ key: key, value: value});
423 this.sortEntries();
424}
425
426SortedArray.prototype.removeAt = function(index) {
427 this.entries.splice(index, 1);
428}
429
Jeff Thompsondf0a6f72012-10-21 15:58:58 -0700430/*
Jeff Thompsonbd829262012-11-30 22:28:37 -0800431 * Scan the name from the last component to the first (skipping special name components)
Jeff Thompson25b06412012-10-21 20:07:57 -0700432 * for a recognized file name extension, and return an object with properties contentType and charset.
Jeff Thompsondf0a6f72012-10-21 15:58:58 -0700433 */
Jeff Thompsone769c512012-11-04 17:25:07 -0800434function getNameContentTypeAndCharset(name) {
Jeff Thompson16a35f72012-11-25 08:07:33 -0800435 var iFileName = name.indexOfFileName();
436 if (iFileName < 0)
437 // Get the default mime type.
438 return MimeTypes.getContentTypeAndCharset("");
Jeff Thompsondf0a6f72012-10-21 15:58:58 -0700439
Jeff Thompson16a35f72012-11-25 08:07:33 -0800440 return MimeTypes.getContentTypeAndCharset
441 (DataUtils.toString(name.components[iFileName]).toLowerCase());
Jeff Thompsondf0a6f72012-10-21 15:58:58 -0700442}
Jeff Thompson10de4592012-10-21 23:54:18 -0700443
444/*
Jeff Thompson9e6dff02012-11-04 09:20:47 -0800445 * Return true if the last component in the name is a segment number..
Jeff Thompson10de4592012-10-21 23:54:18 -0700446 */
Jeff Thompson9e6dff02012-11-04 09:20:47 -0800447function endsWithSegmentNumber(name) {
Jeff Thompson10de4592012-10-21 23:54:18 -0700448 return name.components != null && name.components.length >= 1 &&
449 name.components[name.components.length - 1].length >= 1 &&
450 name.components[name.components.length - 1][0] == 0;
Jeff Thompson5fc9b672012-11-24 10:00:56 -0800451}
452
453/*
Jeff Thompsonbd829262012-11-30 22:28:37 -0800454 * Find all search keys starting with "ndn." and set the attribute in template.
455 * Return the search string including the starting "?" but with the "ndn." keys removed,
Jeff Thompson5fc9b672012-11-24 10:00:56 -0800456 * or return "" if there are no search terms left.
457 */
Jeff Thompsonbd829262012-11-30 22:28:37 -0800458function extractNdnSearch(search, template) {
Jeff Thompson5fc9b672012-11-24 10:00:56 -0800459 if (!(search.length >= 1 && search[0] == '?'))
460 return search;
461
462 var terms = search.substr(1).split('&');
463 var i = 0;
464 while (i < terms.length) {
465 var keyValue = terms[i].split('=');
466 var key = keyValue[0].trim();
Jeff Thompsonbd829262012-11-30 22:28:37 -0800467 if (key.substr(0, 4) == "ndn.") {
Jeff Thompson5fc9b672012-11-24 10:00:56 -0800468 if (keyValue.length >= 1) {
Jeff Thompson754652d2012-11-24 16:23:43 -0800469 var value = keyValue[1].trim();
Jeff Thompson5fc9b672012-11-24 10:00:56 -0800470 var nonNegativeInt = parseInt(value);
471
Jeff Thompsonbd829262012-11-30 22:28:37 -0800472 if (key == "ndn.MinSuffixComponents" && nonNegativeInt >= 0)
Jeff Thompson5fc9b672012-11-24 10:00:56 -0800473 template.minSuffixComponents = nonNegativeInt;
Jeff Thompson6ac75d22013-02-04 22:41:34 -0800474 else if (key == "ndn.MaxSuffixComponents" && nonNegativeInt >= 0)
Jeff Thompson5fc9b672012-11-24 10:00:56 -0800475 template.maxSuffixComponents = nonNegativeInt;
Jeff Thompson6ac75d22013-02-04 22:41:34 -0800476 else if (key == "ndn.ChildSelector" && nonNegativeInt >= 0)
Jeff Thompson5fc9b672012-11-24 10:00:56 -0800477 template.childSelector = nonNegativeInt;
Jeff Thompson6ac75d22013-02-04 22:41:34 -0800478 else if (key == "ndn.AnswerOriginKind" && nonNegativeInt >= 0)
Jeff Thompson5fc9b672012-11-24 10:00:56 -0800479 template.answerOriginKind = nonNegativeInt;
Jeff Thompson6ac75d22013-02-04 22:41:34 -0800480 else if (key == "ndn.Scope" && nonNegativeInt >= 0)
Jeff Thompson5fc9b672012-11-24 10:00:56 -0800481 template.scope = nonNegativeInt;
Jeff Thompson6ac75d22013-02-04 22:41:34 -0800482 else if (key == "ndn.InterestLifetime" && nonNegativeInt >= 0)
Jeff Thompson5fc9b672012-11-24 10:00:56 -0800483 template.interestLifetime = nonNegativeInt;
Jeff Thompson6ac75d22013-02-04 22:41:34 -0800484 else if (key == "ndn.PublisherPublicKeyDigest")
Jeff Thompson5fc9b672012-11-24 10:00:56 -0800485 template.publisherPublicKeyDigest = DataUtils.toNumbersFromString(unescape(value));
Jeff Thompson6ac75d22013-02-04 22:41:34 -0800486 else if (key == "ndn.Nonce")
Jeff Thompson5fc9b672012-11-24 10:00:56 -0800487 template.nonce = DataUtils.toNumbersFromString(unescape(value));
Jeff Thompson6ac75d22013-02-04 22:41:34 -0800488 else if (key == "ndn.Exclude")
489 template.exclude = parseExclude(value);
Jeff Thompson5fc9b672012-11-24 10:00:56 -0800490 }
491
Jeff Thompsonbd829262012-11-30 22:28:37 -0800492 // Remove the "ndn." term and don't advance i.
Jeff Thompson5fc9b672012-11-24 10:00:56 -0800493 terms.splice(i, 1);
494 }
495 else
496 ++i;
497 }
498
499 if (terms.length == 0)
500 return "";
501 else
502 return "?" + terms.join('&');
Jeff Thompson963d2da2012-12-02 23:31:22 -0800503}
Jeff Thompson6ac75d22013-02-04 22:41:34 -0800504
505/*
506 * Parse the comma-separated list of exclude components and return an Exclude.
507 */
508function parseExclude(value) {
509 var excludeValues = [];
510
511 var splitValue = value.split(',');
512 for (var i = 0; i < splitValue.length; ++i) {
513 var element = splitValue[i].trim();
514 if (element == "*")
Jeff Thompson4a4caba2013-02-28 21:31:33 -0800515 excludeValues.push(Exclude.ANY)
Jeff Thompson6ac75d22013-02-04 22:41:34 -0800516 else
517 excludeValues.push(Name.fromEscapedString(element));
518 }
519
520 return new Exclude(excludeValues);
521}
Jeff Thompson4a4caba2013-02-28 21:31:33 -0800522
523/*
524 * Return the index of the first compoment that starts with %C1.META, or -1 if not found.
525 */
526function getIndexOfMetaComponent(name) {
527 for (var i = 0; i < name.components.length; ++i) {
528 var component = name.components[i];
529 if (component.length >= MetaComponentPrefix.length &&
530 DataUtils.arraysEqual(component.subarray(0, MetaComponentPrefix.length),
531 MetaComponentPrefix))
532 return i;
533 }
534
535 return -1;
536}
537
538var MetaComponentPrefix = new Uint8Array([0xc1, 0x2e, 0x4d, 0x45, 0x54, 0x41]);