Line data Source code
1 : /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 : /* This Source Code Form is subject to the terms of the Mozilla Public
3 : * License, v. 2.0. If a copy of the MPL was not distributed with this
4 : * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
5 :
6 : #include "nsMultiMixedConv.h"
7 : #include "plstr.h"
8 : #include "nsIHttpChannel.h"
9 : #include "nsNetCID.h"
10 : #include "nsMimeTypes.h"
11 : #include "nsIStringStream.h"
12 : #include "nsCRT.h"
13 : #include "nsIHttpChannelInternal.h"
14 : #include "nsURLHelper.h"
15 : #include "nsIStreamConverterService.h"
16 : #include "nsICacheInfoChannel.h"
17 : #include <algorithm>
18 : #include "nsContentSecurityManager.h"
19 : #include "nsHttp.h"
20 : #include "nsNetUtil.h"
21 : #include "nsIURI.h"
22 : #include "nsHttpHeaderArray.h"
23 : #include "mozilla/AutoRestore.h"
24 :
25 0 : nsPartChannel::nsPartChannel(nsIChannel *aMultipartChannel, uint32_t aPartID,
26 0 : nsIStreamListener* aListener) :
27 : mMultipartChannel(aMultipartChannel),
28 : mListener(aListener),
29 : mStatus(NS_OK),
30 : mContentLength(UINT64_MAX),
31 : mIsByteRangeRequest(false),
32 : mByteRangeStart(0),
33 : mByteRangeEnd(0),
34 : mPartID(aPartID),
35 0 : mIsLastPart(false)
36 : {
37 : // Inherit the load flags from the original channel...
38 0 : mMultipartChannel->GetLoadFlags(&mLoadFlags);
39 :
40 0 : mMultipartChannel->GetLoadGroup(getter_AddRefs(mLoadGroup));
41 0 : }
42 :
43 0 : nsPartChannel::~nsPartChannel()
44 : {
45 0 : }
46 :
47 0 : void nsPartChannel::InitializeByteRange(int64_t aStart, int64_t aEnd)
48 : {
49 0 : mIsByteRangeRequest = true;
50 :
51 0 : mByteRangeStart = aStart;
52 0 : mByteRangeEnd = aEnd;
53 0 : }
54 :
55 0 : nsresult nsPartChannel::SendOnStartRequest(nsISupports* aContext)
56 : {
57 0 : return mListener->OnStartRequest(this, aContext);
58 : }
59 :
60 0 : nsresult nsPartChannel::SendOnDataAvailable(nsISupports* aContext,
61 : nsIInputStream* aStream,
62 : uint64_t aOffset, uint32_t aLen)
63 : {
64 0 : return mListener->OnDataAvailable(this, aContext, aStream, aOffset, aLen);
65 : }
66 :
67 0 : nsresult nsPartChannel::SendOnStopRequest(nsISupports* aContext,
68 : nsresult aStatus)
69 : {
70 : // Drop the listener
71 0 : nsCOMPtr<nsIStreamListener> listener;
72 0 : listener.swap(mListener);
73 0 : return listener->OnStopRequest(this, aContext, aStatus);
74 : }
75 :
76 0 : void nsPartChannel::SetContentDisposition(const nsACString& aContentDispositionHeader)
77 : {
78 0 : mContentDispositionHeader = aContentDispositionHeader;
79 0 : nsCOMPtr<nsIURI> uri;
80 0 : GetURI(getter_AddRefs(uri));
81 0 : NS_GetFilenameFromDisposition(mContentDispositionFilename,
82 0 : mContentDispositionHeader, uri);
83 0 : mContentDisposition = NS_GetContentDispositionFromHeader(mContentDispositionHeader, this);
84 0 : }
85 :
86 : //
87 : // nsISupports implementation...
88 : //
89 :
90 0 : NS_IMPL_ADDREF(nsPartChannel)
91 0 : NS_IMPL_RELEASE(nsPartChannel)
92 :
93 0 : NS_INTERFACE_MAP_BEGIN(nsPartChannel)
94 0 : NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, nsIChannel)
95 0 : NS_INTERFACE_MAP_ENTRY(nsIRequest)
96 0 : NS_INTERFACE_MAP_ENTRY(nsIChannel)
97 0 : NS_INTERFACE_MAP_ENTRY(nsIByteRangeRequest)
98 0 : NS_INTERFACE_MAP_ENTRY(nsIMultiPartChannel)
99 0 : NS_INTERFACE_MAP_END
100 :
101 : //
102 : // nsIRequest implementation...
103 : //
104 :
105 : NS_IMETHODIMP
106 0 : nsPartChannel::GetName(nsACString &aResult)
107 : {
108 0 : return mMultipartChannel->GetName(aResult);
109 : }
110 :
111 : NS_IMETHODIMP
112 0 : nsPartChannel::IsPending(bool *aResult)
113 : {
114 : // For now, consider the active lifetime of each part the same as
115 : // the underlying multipart channel... This is not exactly right,
116 : // but it is good enough :-)
117 0 : return mMultipartChannel->IsPending(aResult);
118 : }
119 :
120 : NS_IMETHODIMP
121 0 : nsPartChannel::GetStatus(nsresult *aResult)
122 : {
123 0 : nsresult rv = NS_OK;
124 :
125 0 : if (NS_FAILED(mStatus)) {
126 0 : *aResult = mStatus;
127 : } else {
128 0 : rv = mMultipartChannel->GetStatus(aResult);
129 : }
130 :
131 0 : return rv;
132 : }
133 :
134 : NS_IMETHODIMP
135 0 : nsPartChannel::Cancel(nsresult aStatus)
136 : {
137 : // Cancelling an individual part must not cancel the underlying
138 : // multipart channel...
139 : // XXX but we should stop sending data for _this_ part channel!
140 0 : mStatus = aStatus;
141 0 : return NS_OK;
142 : }
143 :
144 : NS_IMETHODIMP
145 0 : nsPartChannel::Suspend(void)
146 : {
147 : // Suspending an individual part must not suspend the underlying
148 : // multipart channel...
149 : // XXX why not?
150 0 : return NS_OK;
151 : }
152 :
153 : NS_IMETHODIMP
154 0 : nsPartChannel::Resume(void)
155 : {
156 : // Resuming an individual part must not resume the underlying
157 : // multipart channel...
158 : // XXX why not?
159 0 : return NS_OK;
160 : }
161 :
162 : //
163 : // nsIChannel implementation
164 : //
165 :
166 : NS_IMETHODIMP
167 0 : nsPartChannel::GetOriginalURI(nsIURI * *aURI)
168 : {
169 0 : return mMultipartChannel->GetOriginalURI(aURI);
170 : }
171 :
172 : NS_IMETHODIMP
173 0 : nsPartChannel::SetOriginalURI(nsIURI *aURI)
174 : {
175 0 : return mMultipartChannel->SetOriginalURI(aURI);
176 : }
177 :
178 : NS_IMETHODIMP
179 0 : nsPartChannel::GetURI(nsIURI * *aURI)
180 : {
181 0 : return mMultipartChannel->GetURI(aURI);
182 : }
183 :
184 : NS_IMETHODIMP
185 0 : nsPartChannel::Open(nsIInputStream **result)
186 : {
187 : // This channel cannot be opened!
188 0 : return NS_ERROR_FAILURE;
189 : }
190 :
191 : NS_IMETHODIMP
192 0 : nsPartChannel::Open2(nsIInputStream** aStream)
193 : {
194 0 : nsCOMPtr<nsIStreamListener> listener;
195 0 : nsresult rv = nsContentSecurityManager::doContentSecurityCheck(this, listener);
196 0 : NS_ENSURE_SUCCESS(rv, rv);
197 0 : return Open(aStream);
198 : }
199 :
200 : NS_IMETHODIMP
201 0 : nsPartChannel::AsyncOpen(nsIStreamListener *aListener, nsISupports *aContext)
202 : {
203 : // This channel cannot be opened!
204 0 : return NS_ERROR_FAILURE;
205 : }
206 :
207 : NS_IMETHODIMP
208 0 : nsPartChannel::AsyncOpen2(nsIStreamListener *aListener)
209 : {
210 0 : nsCOMPtr<nsIStreamListener> listener = aListener;
211 0 : nsresult rv = nsContentSecurityManager::doContentSecurityCheck(this, listener);
212 0 : NS_ENSURE_SUCCESS(rv, rv);
213 0 : return AsyncOpen(listener, nullptr);
214 : }
215 :
216 : NS_IMETHODIMP
217 0 : nsPartChannel::GetLoadFlags(nsLoadFlags *aLoadFlags)
218 : {
219 0 : *aLoadFlags = mLoadFlags;
220 0 : return NS_OK;
221 : }
222 :
223 : NS_IMETHODIMP
224 0 : nsPartChannel::SetLoadFlags(nsLoadFlags aLoadFlags)
225 : {
226 0 : mLoadFlags = aLoadFlags;
227 0 : return NS_OK;
228 : }
229 :
230 : NS_IMETHODIMP
231 0 : nsPartChannel::GetIsDocument(bool *aIsDocument)
232 : {
233 0 : return NS_GetIsDocumentChannel(this, aIsDocument);
234 : }
235 :
236 : NS_IMETHODIMP
237 0 : nsPartChannel::GetLoadGroup(nsILoadGroup* *aLoadGroup)
238 : {
239 0 : *aLoadGroup = mLoadGroup;
240 0 : NS_IF_ADDREF(*aLoadGroup);
241 :
242 0 : return NS_OK;
243 : }
244 :
245 : NS_IMETHODIMP
246 0 : nsPartChannel::SetLoadGroup(nsILoadGroup* aLoadGroup)
247 : {
248 0 : mLoadGroup = aLoadGroup;
249 :
250 0 : return NS_OK;
251 : }
252 :
253 : NS_IMETHODIMP
254 0 : nsPartChannel::GetOwner(nsISupports* *aOwner)
255 : {
256 0 : return mMultipartChannel->GetOwner(aOwner);
257 : }
258 :
259 : NS_IMETHODIMP
260 0 : nsPartChannel::SetOwner(nsISupports* aOwner)
261 : {
262 0 : return mMultipartChannel->SetOwner(aOwner);
263 : }
264 :
265 : NS_IMETHODIMP
266 0 : nsPartChannel::GetLoadInfo(nsILoadInfo* *aLoadInfo)
267 : {
268 0 : return mMultipartChannel->GetLoadInfo(aLoadInfo);
269 : }
270 :
271 : NS_IMETHODIMP
272 0 : nsPartChannel::SetLoadInfo(nsILoadInfo* aLoadInfo)
273 : {
274 0 : return mMultipartChannel->SetLoadInfo(aLoadInfo);
275 : }
276 :
277 : NS_IMETHODIMP
278 0 : nsPartChannel::GetNotificationCallbacks(nsIInterfaceRequestor* *aCallbacks)
279 : {
280 0 : return mMultipartChannel->GetNotificationCallbacks(aCallbacks);
281 : }
282 :
283 : NS_IMETHODIMP
284 0 : nsPartChannel::SetNotificationCallbacks(nsIInterfaceRequestor* aCallbacks)
285 : {
286 0 : return mMultipartChannel->SetNotificationCallbacks(aCallbacks);
287 : }
288 :
289 : NS_IMETHODIMP
290 0 : nsPartChannel::GetSecurityInfo(nsISupports * *aSecurityInfo)
291 : {
292 0 : return mMultipartChannel->GetSecurityInfo(aSecurityInfo);
293 : }
294 :
295 : NS_IMETHODIMP
296 0 : nsPartChannel::GetContentType(nsACString &aContentType)
297 : {
298 0 : aContentType = mContentType;
299 0 : return NS_OK;
300 : }
301 :
302 : NS_IMETHODIMP
303 0 : nsPartChannel::SetContentType(const nsACString &aContentType)
304 : {
305 : bool dummy;
306 0 : net_ParseContentType(aContentType, mContentType, mContentCharset, &dummy);
307 0 : return NS_OK;
308 : }
309 :
310 : NS_IMETHODIMP
311 0 : nsPartChannel::GetContentCharset(nsACString &aContentCharset)
312 : {
313 0 : aContentCharset = mContentCharset;
314 0 : return NS_OK;
315 : }
316 :
317 : NS_IMETHODIMP
318 0 : nsPartChannel::SetContentCharset(const nsACString &aContentCharset)
319 : {
320 0 : mContentCharset = aContentCharset;
321 0 : return NS_OK;
322 : }
323 :
324 : NS_IMETHODIMP
325 0 : nsPartChannel::GetContentLength(int64_t *aContentLength)
326 : {
327 0 : *aContentLength = mContentLength;
328 0 : return NS_OK;
329 : }
330 :
331 : NS_IMETHODIMP
332 0 : nsPartChannel::SetContentLength(int64_t aContentLength)
333 : {
334 0 : mContentLength = aContentLength;
335 0 : return NS_OK;
336 : }
337 :
338 : NS_IMETHODIMP
339 0 : nsPartChannel::GetContentDisposition(uint32_t *aContentDisposition)
340 : {
341 0 : if (mContentDispositionHeader.IsEmpty())
342 0 : return NS_ERROR_NOT_AVAILABLE;
343 :
344 0 : *aContentDisposition = mContentDisposition;
345 0 : return NS_OK;
346 : }
347 :
348 : NS_IMETHODIMP
349 0 : nsPartChannel::SetContentDisposition(uint32_t aContentDisposition)
350 : {
351 0 : return NS_ERROR_NOT_AVAILABLE;
352 : }
353 :
354 : NS_IMETHODIMP
355 0 : nsPartChannel::GetContentDispositionFilename(nsAString &aContentDispositionFilename)
356 : {
357 0 : if (mContentDispositionFilename.IsEmpty())
358 0 : return NS_ERROR_NOT_AVAILABLE;
359 :
360 0 : aContentDispositionFilename = mContentDispositionFilename;
361 0 : return NS_OK;
362 : }
363 :
364 : NS_IMETHODIMP
365 0 : nsPartChannel::SetContentDispositionFilename(const nsAString &aContentDispositionFilename)
366 : {
367 0 : return NS_ERROR_NOT_AVAILABLE;
368 : }
369 :
370 :
371 : NS_IMETHODIMP
372 0 : nsPartChannel::GetContentDispositionHeader(nsACString &aContentDispositionHeader)
373 : {
374 0 : if (mContentDispositionHeader.IsEmpty())
375 0 : return NS_ERROR_NOT_AVAILABLE;
376 :
377 0 : aContentDispositionHeader = mContentDispositionHeader;
378 0 : return NS_OK;
379 : }
380 :
381 : NS_IMETHODIMP
382 0 : nsPartChannel::GetPartID(uint32_t *aPartID)
383 : {
384 0 : *aPartID = mPartID;
385 0 : return NS_OK;
386 : }
387 :
388 : NS_IMETHODIMP
389 0 : nsPartChannel::GetIsLastPart(bool *aIsLastPart)
390 : {
391 0 : *aIsLastPart = mIsLastPart;
392 0 : return NS_OK;
393 : }
394 :
395 : //
396 : // nsIByteRangeRequest implementation...
397 : //
398 :
399 : NS_IMETHODIMP
400 0 : nsPartChannel::GetIsByteRangeRequest(bool *aIsByteRangeRequest)
401 : {
402 0 : *aIsByteRangeRequest = mIsByteRangeRequest;
403 :
404 0 : return NS_OK;
405 : }
406 :
407 :
408 : NS_IMETHODIMP
409 0 : nsPartChannel::GetStartRange(int64_t *aStartRange)
410 : {
411 0 : *aStartRange = mByteRangeStart;
412 :
413 0 : return NS_OK;
414 : }
415 :
416 : NS_IMETHODIMP
417 0 : nsPartChannel::GetEndRange(int64_t *aEndRange)
418 : {
419 0 : *aEndRange = mByteRangeEnd;
420 0 : return NS_OK;
421 : }
422 :
423 : NS_IMETHODIMP
424 0 : nsPartChannel::GetBaseChannel(nsIChannel ** aReturn)
425 : {
426 0 : NS_ENSURE_ARG_POINTER(aReturn);
427 :
428 0 : *aReturn = mMultipartChannel;
429 0 : NS_IF_ADDREF(*aReturn);
430 0 : return NS_OK;
431 : }
432 :
433 : // nsISupports implementation
434 0 : NS_IMPL_ISUPPORTS(nsMultiMixedConv,
435 : nsIStreamConverter,
436 : nsIStreamListener,
437 : nsIRequestObserver)
438 :
439 :
440 : // nsIStreamConverter implementation
441 :
442 : // No syncronous conversion at this time.
443 : NS_IMETHODIMP
444 0 : nsMultiMixedConv::Convert(nsIInputStream *aFromStream,
445 : const char *aFromType,
446 : const char *aToType,
447 : nsISupports *aCtxt, nsIInputStream **_retval) {
448 0 : return NS_ERROR_NOT_IMPLEMENTED;
449 : }
450 :
451 : // Stream converter service calls this to initialize the actual stream converter (us).
452 : NS_IMETHODIMP
453 0 : nsMultiMixedConv::AsyncConvertData(const char *aFromType, const char *aToType,
454 : nsIStreamListener *aListener, nsISupports *aCtxt) {
455 0 : NS_ASSERTION(aListener && aFromType && aToType, "null pointer passed into multi mixed converter");
456 :
457 : // hook up our final listener. this guy gets the various On*() calls we want to throw
458 : // at him.
459 : //
460 : // WARNING: this listener must be able to handle multiple OnStartRequest, OnDataAvail()
461 : // and OnStopRequest() call combinations. We call of series of these for each sub-part
462 : // in the raw stream.
463 0 : mFinalListener = aListener;
464 :
465 0 : return NS_OK;
466 : }
467 :
468 : // nsIRequestObserver implementation
469 : NS_IMETHODIMP
470 0 : nsMultiMixedConv::OnStartRequest(nsIRequest *request, nsISupports *ctxt)
471 : {
472 : // we're assuming the content-type is available at this stage
473 0 : NS_ASSERTION(mBoundary.IsEmpty(), "a second on start???");
474 :
475 : nsresult rv;
476 :
477 0 : mContext = ctxt;
478 0 : mTotalSent = 0;
479 0 : mChannel = do_QueryInterface(request, &rv);
480 0 : if (NS_FAILED(rv)) return rv;
481 :
482 0 : nsAutoCString contentType;
483 :
484 : // ask the HTTP channel for the content-type and extract the boundary from it.
485 0 : nsCOMPtr<nsIHttpChannel> httpChannel = do_QueryInterface(mChannel, &rv);
486 0 : if (NS_SUCCEEDED(rv)) {
487 0 : rv = httpChannel->GetResponseHeader(NS_LITERAL_CSTRING("content-type"), contentType);
488 0 : if (NS_FAILED(rv)) {
489 0 : return rv;
490 : }
491 : } else {
492 : // try asking the channel directly
493 0 : rv = mChannel->GetContentType(contentType);
494 0 : if (NS_FAILED(rv)) {
495 0 : return NS_ERROR_FAILURE;
496 : }
497 : }
498 :
499 0 : Tokenizer p(contentType);
500 0 : p.SkipUntil(Token::Char(';'));
501 0 : if (!p.CheckChar(';')) {
502 0 : return NS_ERROR_CORRUPTED_CONTENT;
503 : }
504 0 : p.SkipWhites();
505 0 : if (!p.CheckWord("boundary")) {
506 0 : return NS_ERROR_CORRUPTED_CONTENT;
507 : }
508 0 : p.SkipWhites();
509 0 : if (!p.CheckChar('=')) {
510 0 : return NS_ERROR_CORRUPTED_CONTENT;
511 : }
512 0 : p.SkipWhites();
513 0 : Unused << p.ReadUntil(Token::Char(';'), mBoundary);
514 0 : mBoundary.Trim(" \""); // ignoring potential quoted string formatting violations
515 0 : if (mBoundary.IsEmpty()) {
516 0 : return NS_ERROR_CORRUPTED_CONTENT;
517 : }
518 :
519 : mHeaderTokens[HEADER_CONTENT_TYPE] =
520 0 : mTokenizer.AddCustomToken("content-type", mTokenizer.CASE_INSENSITIVE, false);
521 : mHeaderTokens[HEADER_CONTENT_LENGTH] =
522 0 : mTokenizer.AddCustomToken("content-length", mTokenizer.CASE_INSENSITIVE, false);
523 : mHeaderTokens[HEADER_CONTENT_DISPOSITION] =
524 0 : mTokenizer.AddCustomToken("content-disposition", mTokenizer.CASE_INSENSITIVE, false);
525 : mHeaderTokens[HEADER_SET_COOKIE] =
526 0 : mTokenizer.AddCustomToken("set-cookie", mTokenizer.CASE_INSENSITIVE, false);
527 : mHeaderTokens[HEADER_CONTENT_RANGE] =
528 0 : mTokenizer.AddCustomToken("content-range", mTokenizer.CASE_INSENSITIVE, false);
529 : mHeaderTokens[HEADER_RANGE] =
530 0 : mTokenizer.AddCustomToken("range", mTokenizer.CASE_INSENSITIVE, false);
531 :
532 0 : mLFToken = mTokenizer.AddCustomToken("\n", mTokenizer.CASE_SENSITIVE, false);
533 0 : mCRLFToken = mTokenizer.AddCustomToken("\r\n", mTokenizer.CASE_SENSITIVE, false);
534 :
535 0 : SwitchToControlParsing();
536 :
537 : mBoundaryToken =
538 0 : mTokenizer.AddCustomToken(mBoundary, mTokenizer.CASE_SENSITIVE);
539 : mBoundaryTokenWithDashes =
540 0 : mTokenizer.AddCustomToken(NS_LITERAL_CSTRING("--") + mBoundary, mTokenizer.CASE_SENSITIVE);
541 :
542 0 : return NS_OK;
543 : }
544 :
545 : // nsIStreamListener implementation
546 : NS_IMETHODIMP
547 0 : nsMultiMixedConv::OnDataAvailable(nsIRequest *request, nsISupports *context,
548 : nsIInputStream *inStr, uint64_t sourceOffset,
549 : uint32_t count)
550 : {
551 : // Failing these assertions may indicate that some of the target listeners of this converter
552 : // is looping the thead queue, which is harmful to how we collect the raw (content) data.
553 0 : MOZ_DIAGNOSTIC_ASSERT(!mInOnDataAvailable, "nsMultiMixedConv::OnDataAvailable reentered!");
554 0 : MOZ_DIAGNOSTIC_ASSERT(!mRawData, "There are unsent data from the previous tokenizer feed!");
555 :
556 0 : if (mInOnDataAvailable) {
557 : // The multipart logic is incapable of being reentered.
558 0 : return NS_ERROR_UNEXPECTED;
559 : }
560 :
561 0 : mozilla::AutoRestore<bool> restore(mInOnDataAvailable);
562 0 : mInOnDataAvailable = true;
563 :
564 0 : nsresult rv_feed = mTokenizer.FeedInput(inStr, count);
565 : // We must do this every time. Regardless if something has failed during the
566 : // parsing process. Otherwise the raw data reference would not be thrown away.
567 0 : nsresult rv_send = SendData();
568 :
569 0 : return NS_FAILED(rv_send) ? rv_send : rv_feed;
570 : }
571 :
572 : NS_IMETHODIMP
573 0 : nsMultiMixedConv::OnStopRequest(nsIRequest *request, nsISupports *ctxt,
574 : nsresult aStatus)
575 : {
576 : nsresult rv;
577 :
578 0 : if (mBoundary.IsEmpty()) { // no token, no love.
579 0 : return NS_ERROR_FAILURE;
580 : }
581 :
582 0 : if (mPartChannel) {
583 0 : mPartChannel->SetIsLastPart();
584 :
585 0 : MOZ_DIAGNOSTIC_ASSERT(!mRawData, "There are unsent data from the previous tokenizer feed!");
586 :
587 0 : rv = mTokenizer.FinishInput();
588 0 : if (NS_SUCCEEDED(aStatus)) {
589 0 : aStatus = rv;
590 : }
591 0 : rv = SendData();
592 0 : if (NS_SUCCEEDED(aStatus)) {
593 0 : aStatus = rv;
594 : }
595 :
596 0 : (void) SendStop(aStatus);
597 0 : } else if (NS_FAILED(aStatus) && !mRequestListenerNotified) {
598 : // underlying data production problem. we should not be in
599 : // the middle of sending data. if we were, mPartChannel,
600 : // above, would have been non-null.
601 :
602 0 : (void) mFinalListener->OnStartRequest(request, ctxt);
603 0 : (void) mFinalListener->OnStopRequest(request, ctxt, aStatus);
604 : }
605 :
606 0 : return NS_OK;
607 : }
608 :
609 : nsresult
610 0 : nsMultiMixedConv::ConsumeToken(Token const & token)
611 : {
612 : nsresult rv;
613 :
614 0 : switch (mParserState) {
615 : case PREAMBLE:
616 0 : if (token.Equals(mBoundaryTokenWithDashes)) {
617 : // The server first used boundary '--boundary'. Hence, we no longer
618 : // accept plain 'boundary' token as a delimiter.
619 0 : mTokenizer.RemoveCustomToken(mBoundaryToken);
620 0 : mParserState = BOUNDARY_CRLF;
621 0 : break;
622 : }
623 0 : if (token.Equals(mBoundaryToken)) {
624 : // And here the opposite from the just above block...
625 0 : mTokenizer.RemoveCustomToken(mBoundaryTokenWithDashes);
626 0 : mParserState = BOUNDARY_CRLF;
627 0 : break;
628 : }
629 :
630 : // This is a preamble, just ignore it and wait for the boundary.
631 0 : break;
632 :
633 : case BOUNDARY_CRLF:
634 0 : if (token.Equals(Token::NewLine())) {
635 0 : mParserState = HEADER_NAME;
636 0 : mResponseHeader = HEADER_UNKNOWN;
637 0 : HeadersToDefault();
638 0 : SetHeaderTokensEnabled(true);
639 0 : break;
640 : }
641 0 : return NS_ERROR_CORRUPTED_CONTENT;
642 :
643 : case HEADER_NAME:
644 0 : SetHeaderTokensEnabled(false);
645 0 : if (token.Equals(Token::NewLine())) {
646 0 : mParserState = BODY_INIT;
647 0 : SwitchToBodyParsing();
648 0 : break;
649 : }
650 0 : for (uint32_t h = HEADER_CONTENT_TYPE; h < HEADER_UNKNOWN; ++h) {
651 0 : if (token.Equals(mHeaderTokens[h])) {
652 0 : mResponseHeader = static_cast<EHeader>(h);
653 0 : break;
654 : }
655 : }
656 0 : mParserState = HEADER_SEP;
657 0 : break;
658 :
659 : case HEADER_SEP:
660 0 : if (token.Equals(Token::Char(':'))) {
661 0 : mParserState = HEADER_VALUE;
662 0 : mResponseHeaderValue.Truncate();
663 0 : break;
664 : }
665 0 : if (mResponseHeader == HEADER_UNKNOWN) {
666 : // If the header is not of any we understand, just pass everything till ':'
667 0 : break;
668 : }
669 0 : if (token.Equals(Token::Whitespace())) {
670 : // Accept only header-name traling whitespaces after known headers
671 0 : break;
672 : }
673 0 : return NS_ERROR_CORRUPTED_CONTENT;
674 :
675 : case HEADER_VALUE:
676 0 : if (token.Equals(Token::Whitespace()) && mResponseHeaderValue.IsEmpty()) {
677 : // Eat leading whitespaces
678 0 : break;
679 : }
680 0 : if (token.Equals(Token::NewLine())) {
681 0 : nsresult rv = ProcessHeader();
682 0 : if (NS_FAILED(rv)) {
683 0 : return rv;
684 : }
685 0 : mParserState = HEADER_NAME;
686 0 : mResponseHeader = HEADER_UNKNOWN;
687 0 : SetHeaderTokensEnabled(true);
688 : } else {
689 0 : mResponseHeaderValue.Append(token.Fragment());
690 : }
691 0 : break;
692 :
693 : case BODY_INIT:
694 0 : rv = SendStart();
695 0 : if (NS_FAILED(rv)) {
696 0 : return rv;
697 : }
698 0 : mParserState = BODY;
699 : MOZ_FALLTHROUGH;
700 :
701 : case BODY: {
702 0 : if (!token.Equals(mLFToken) && !token.Equals(mCRLFToken)) {
703 0 : if (token.Equals(mBoundaryTokenWithDashes) ||
704 0 : token.Equals(mBoundaryToken)) {
705 : // Allow CRLF to NOT be part of the boundary as well
706 0 : SwitchToControlParsing();
707 0 : mParserState = TRAIL_DASH1;
708 0 : break;
709 : }
710 0 : AccumulateData(token);
711 0 : break;
712 : }
713 :
714 : // After CRLF we must explicitly check for boundary. If found,
715 : // that CRLF is part of the boundary and must not be send to the
716 : // data listener.
717 0 : Token token2;
718 0 : if (!mTokenizer.Next(token2)) {
719 : // Note: this will give us the CRLF token again when more data
720 : // or OnStopRequest arrive. I.e. we will enter BODY case in
721 : // the very same state as we are now and start this block over.
722 0 : mTokenizer.NeedMoreInput();
723 0 : break;
724 : }
725 0 : if (token2.Equals(mBoundaryTokenWithDashes) ||
726 0 : token2.Equals(mBoundaryToken)) {
727 0 : SwitchToControlParsing();
728 0 : mParserState = TRAIL_DASH1;
729 0 : break;
730 : }
731 :
732 0 : AccumulateData(token);
733 0 : AccumulateData(token2);
734 0 : break;
735 : }
736 :
737 : case TRAIL_DASH1:
738 0 : if (token.Equals(Token::NewLine())) {
739 0 : rv = SendStop(NS_OK);
740 0 : if (NS_FAILED(rv)) {
741 0 : return rv;
742 : }
743 0 : mParserState = BOUNDARY_CRLF;
744 0 : mTokenizer.Rollback();
745 0 : break;
746 : }
747 0 : if (token.Equals(Token::Char('-'))) {
748 0 : mParserState = TRAIL_DASH2;
749 0 : break;
750 : }
751 0 : return NS_ERROR_CORRUPTED_CONTENT;
752 :
753 : case TRAIL_DASH2:
754 0 : if (token.Equals(Token::Char('-'))) {
755 0 : mPartChannel->SetIsLastPart();
756 : // SendStop calls SendData first.
757 0 : rv = SendStop(NS_OK);
758 0 : if (NS_FAILED(rv)) {
759 0 : return rv;
760 : }
761 0 : mParserState = EPILOGUE;
762 0 : break;
763 : }
764 0 : return NS_ERROR_CORRUPTED_CONTENT;
765 :
766 : case EPILOGUE:
767 : // Just ignore
768 0 : break;
769 :
770 : default:
771 0 : MOZ_ASSERT(false, "Missing parser state handling branch");
772 : break;
773 : } // switch
774 :
775 0 : return NS_OK;
776 : }
777 :
778 : void
779 0 : nsMultiMixedConv::SetHeaderTokensEnabled(bool aEnable)
780 : {
781 0 : for (uint32_t h = HEADER_FIRST; h < HEADER_UNKNOWN; ++h) {
782 0 : mTokenizer.EnableCustomToken(mHeaderTokens[h], aEnable);
783 : }
784 0 : }
785 :
786 : void
787 0 : nsMultiMixedConv::SwitchToBodyParsing()
788 : {
789 0 : mTokenizer.SetTokenizingMode(Tokenizer::Mode::CUSTOM_ONLY);
790 0 : mTokenizer.EnableCustomToken(mLFToken, true);
791 0 : mTokenizer.EnableCustomToken(mCRLFToken, true);
792 0 : mTokenizer.EnableCustomToken(mBoundaryTokenWithDashes, true);
793 0 : mTokenizer.EnableCustomToken(mBoundaryToken, true);
794 0 : }
795 :
796 : void
797 0 : nsMultiMixedConv::SwitchToControlParsing()
798 : {
799 0 : mTokenizer.SetTokenizingMode(Tokenizer::Mode::FULL);
800 0 : mTokenizer.EnableCustomToken(mLFToken, false);
801 0 : mTokenizer.EnableCustomToken(mCRLFToken, false);
802 0 : mTokenizer.EnableCustomToken(mBoundaryTokenWithDashes, false);
803 0 : mTokenizer.EnableCustomToken(mBoundaryToken, false);
804 0 : }
805 :
806 : // nsMultiMixedConv methods
807 0 : nsMultiMixedConv::nsMultiMixedConv() :
808 : mCurrentPartID(0),
809 : mInOnDataAvailable(false),
810 : // XXX: This is a hack to bypass the raw pointer to refcounted object in
811 : // lambda analysis. It should be removed and replaced when the
812 : // IncrementalTokenizer API is improved to avoid the need for such
813 : // workarounds.
814 : //
815 : // This is safe because `mTokenizer` will not outlive `this`, meaning that
816 : // this std::bind object will be destroyed before `this` dies.
817 0 : mTokenizer(std::bind(&nsMultiMixedConv::ConsumeToken, this, std::placeholders::_1))
818 : {
819 0 : mContentLength = UINT64_MAX;
820 0 : mByteRangeStart = 0;
821 0 : mByteRangeEnd = 0;
822 0 : mTotalSent = 0;
823 0 : mIsByteRangeRequest = false;
824 0 : mParserState = INIT;
825 0 : mRawData = nullptr;
826 0 : mRequestListenerNotified = false;
827 0 : }
828 :
829 0 : nsMultiMixedConv::~nsMultiMixedConv() {}
830 :
831 : nsresult
832 0 : nsMultiMixedConv::SendStart()
833 : {
834 0 : nsresult rv = NS_OK;
835 :
836 0 : nsCOMPtr<nsIStreamListener> partListener(mFinalListener);
837 0 : if (mContentType.IsEmpty()) {
838 0 : mContentType.AssignLiteral(UNKNOWN_CONTENT_TYPE);
839 : nsCOMPtr<nsIStreamConverterService> serv =
840 0 : do_GetService(NS_STREAMCONVERTERSERVICE_CONTRACTID, &rv);
841 0 : if (NS_SUCCEEDED(rv)) {
842 0 : nsCOMPtr<nsIStreamListener> converter;
843 0 : rv = serv->AsyncConvertData(UNKNOWN_CONTENT_TYPE,
844 : "*/*",
845 : mFinalListener,
846 : mContext,
847 0 : getter_AddRefs(converter));
848 0 : if (NS_SUCCEEDED(rv)) {
849 0 : partListener = converter;
850 : }
851 : }
852 : }
853 :
854 : // if we already have an mPartChannel, that means we never sent a Stop()
855 : // before starting up another "part." that would be bad.
856 0 : MOZ_ASSERT(!mPartChannel, "tisk tisk, shouldn't be overwriting a channel");
857 :
858 : nsPartChannel *newChannel;
859 0 : newChannel = new nsPartChannel(mChannel, mCurrentPartID++, partListener);
860 0 : if (!newChannel)
861 0 : return NS_ERROR_OUT_OF_MEMORY;
862 :
863 0 : if (mIsByteRangeRequest) {
864 0 : newChannel->InitializeByteRange(mByteRangeStart, mByteRangeEnd);
865 : }
866 :
867 0 : mTotalSent = 0;
868 :
869 : // Set up the new part channel...
870 0 : mPartChannel = newChannel;
871 :
872 0 : rv = mPartChannel->SetContentType(mContentType);
873 0 : if (NS_FAILED(rv)) return rv;
874 :
875 0 : rv = mPartChannel->SetContentLength(mContentLength);
876 0 : if (NS_FAILED(rv)) return rv;
877 :
878 0 : mPartChannel->SetContentDisposition(mContentDisposition);
879 :
880 : // Each part of a multipart/replace response can be used
881 : // for the top level document. We must inform upper layers
882 : // about this by setting the LOAD_REPLACE flag so that certain
883 : // state assertions are evaluated as positive.
884 0 : nsLoadFlags loadFlags = 0;
885 0 : mPartChannel->GetLoadFlags(&loadFlags);
886 0 : loadFlags |= nsIChannel::LOAD_REPLACE;
887 0 : mPartChannel->SetLoadFlags(loadFlags);
888 :
889 0 : nsCOMPtr<nsILoadGroup> loadGroup;
890 0 : (void)mPartChannel->GetLoadGroup(getter_AddRefs(loadGroup));
891 :
892 : // Add the new channel to the load group (if any)
893 0 : if (loadGroup) {
894 0 : rv = loadGroup->AddRequest(mPartChannel, nullptr);
895 0 : if (NS_FAILED(rv)) return rv;
896 : }
897 :
898 : // This prevents artificial call to OnStart/StopRequest when the root
899 : // channel fails. Since now it's ensured to keep with the nsIStreamListener
900 : // contract every time.
901 0 : mRequestListenerNotified = true;
902 :
903 : // Let's start off the load. NOTE: we don't forward on the channel passed
904 : // into our OnDataAvailable() as it's the root channel for the raw stream.
905 0 : return mPartChannel->SendOnStartRequest(mContext);
906 : }
907 :
908 : nsresult
909 0 : nsMultiMixedConv::SendStop(nsresult aStatus)
910 : {
911 : // Make sure we send out all accumulcated data prior call to OnStopRequest.
912 : // If there is no data, this is a no-op.
913 0 : nsresult rv = SendData();
914 0 : if (NS_SUCCEEDED(aStatus)) {
915 0 : aStatus = rv;
916 : }
917 0 : if (mPartChannel) {
918 0 : rv = mPartChannel->SendOnStopRequest(mContext, aStatus);
919 : // don't check for failure here, we need to remove the channel from
920 : // the loadgroup.
921 :
922 : // Remove the channel from its load group (if any)
923 0 : nsCOMPtr<nsILoadGroup> loadGroup;
924 0 : (void) mPartChannel->GetLoadGroup(getter_AddRefs(loadGroup));
925 0 : if (loadGroup)
926 0 : (void) loadGroup->RemoveRequest(mPartChannel, mContext, aStatus);
927 : }
928 :
929 0 : mPartChannel = nullptr;
930 0 : return rv;
931 : }
932 :
933 : void
934 0 : nsMultiMixedConv::AccumulateData(Token const & aToken)
935 : {
936 0 : if (!mRawData) {
937 : // This is the first read of raw data during this FeedInput loop
938 : // of the incremental tokenizer. All 'raw' tokens are coming from
939 : // the same linear buffer, hence begining of this loop raw data
940 : // is begining of the first raw token. Length of this loop raw
941 : // data is just sum of all 'raw' tokens we collect during this loop.
942 : //
943 : // It's ensured we flush (send to to the listener via OnDataAvailable)
944 : // and nullify the collected raw data right after FeedInput call.
945 : // Hence, the reference can't outlive the actual buffer.
946 0 : mRawData = aToken.Fragment().BeginReading();
947 0 : mRawDataLength = 0;
948 : }
949 :
950 0 : mRawDataLength += aToken.Fragment().Length();
951 0 : }
952 :
953 : nsresult
954 0 : nsMultiMixedConv::SendData()
955 : {
956 : nsresult rv;
957 :
958 0 : if (!mRawData) {
959 0 : return NS_OK;
960 : }
961 :
962 0 : nsACString::const_char_iterator rawData = mRawData;
963 0 : mRawData = nullptr;
964 :
965 0 : if (!mPartChannel) {
966 0 : return NS_ERROR_FAILURE; // something went wrong w/ processing
967 : }
968 :
969 0 : if (mContentLength != UINT64_MAX) {
970 : // make sure that we don't send more than the mContentLength
971 : // XXX why? perhaps the Content-Length header was actually wrong!!
972 0 : if ((uint64_t(mRawDataLength) + mTotalSent) > mContentLength)
973 0 : mRawDataLength = static_cast<uint32_t>(mContentLength - mTotalSent);
974 :
975 0 : if (mRawDataLength == 0)
976 0 : return NS_OK;
977 : }
978 :
979 0 : uint64_t offset = mTotalSent;
980 0 : mTotalSent += mRawDataLength;
981 :
982 : nsCOMPtr<nsIStringInputStream> ss(
983 0 : do_CreateInstance("@mozilla.org/io/string-input-stream;1", &rv));
984 0 : if (NS_FAILED(rv))
985 0 : return rv;
986 :
987 0 : rv = ss->ShareData(rawData, mRawDataLength);
988 0 : mRawData = nullptr;
989 0 : if (NS_FAILED(rv))
990 0 : return rv;
991 :
992 0 : nsCOMPtr<nsIInputStream> inStream(do_QueryInterface(ss, &rv));
993 0 : if (NS_FAILED(rv)) return rv;
994 :
995 0 : return mPartChannel->SendOnDataAvailable(mContext, inStream, offset, mRawDataLength);
996 : }
997 :
998 : void
999 0 : nsMultiMixedConv::HeadersToDefault()
1000 : {
1001 0 : mContentLength = UINT64_MAX;
1002 0 : mContentType.Truncate();
1003 0 : mContentDisposition.Truncate();
1004 0 : mIsByteRangeRequest = false;
1005 0 : }
1006 :
1007 : nsresult
1008 0 : nsMultiMixedConv::ProcessHeader()
1009 : {
1010 0 : mozilla::Tokenizer p(mResponseHeaderValue);
1011 :
1012 0 : switch (mResponseHeader) {
1013 : case HEADER_CONTENT_TYPE:
1014 0 : mContentType = mResponseHeaderValue;
1015 0 : mContentType.CompressWhitespace();
1016 0 : break;
1017 : case HEADER_CONTENT_LENGTH:
1018 0 : p.SkipWhites();
1019 0 : if (!p.ReadInteger(&mContentLength)) {
1020 0 : return NS_ERROR_CORRUPTED_CONTENT;
1021 : }
1022 0 : break;
1023 : case HEADER_CONTENT_DISPOSITION:
1024 0 : mContentDisposition = mResponseHeaderValue;
1025 0 : mContentDisposition.CompressWhitespace();
1026 0 : break;
1027 : case HEADER_SET_COOKIE: {
1028 0 : nsCOMPtr<nsIHttpChannelInternal> httpInternal = do_QueryInterface(mChannel);
1029 0 : mResponseHeaderValue.CompressWhitespace();
1030 0 : if (httpInternal) {
1031 0 : DebugOnly<nsresult> rv = httpInternal->SetCookie(mResponseHeaderValue.get());
1032 0 : MOZ_ASSERT(NS_SUCCEEDED(rv));
1033 : }
1034 0 : break;
1035 : }
1036 : case HEADER_RANGE:
1037 : case HEADER_CONTENT_RANGE: {
1038 0 : if (!p.CheckWord("bytes") ||
1039 0 : !p.CheckWhite()) {
1040 0 : return NS_ERROR_CORRUPTED_CONTENT;
1041 : }
1042 0 : p.SkipWhites();
1043 0 : if (p.CheckChar('*')) {
1044 0 : mByteRangeStart = mByteRangeEnd = 0;
1045 0 : } else if (!p.ReadInteger(&mByteRangeStart) ||
1046 0 : !p.CheckChar('-') ||
1047 0 : !p.ReadInteger(&mByteRangeEnd)) {
1048 0 : return NS_ERROR_CORRUPTED_CONTENT;
1049 : }
1050 0 : mIsByteRangeRequest = true;
1051 0 : if (mContentLength == UINT64_MAX) {
1052 0 : mContentLength = uint64_t(mByteRangeEnd - mByteRangeStart + 1);
1053 : }
1054 0 : break;
1055 : }
1056 : case HEADER_UNKNOWN:
1057 : // We ignore anything else...
1058 0 : break;
1059 : }
1060 :
1061 0 : return NS_OK;
1062 : }
1063 :
1064 : nsresult
1065 0 : NS_NewMultiMixedConv(nsMultiMixedConv** aMultiMixedConv)
1066 : {
1067 0 : NS_PRECONDITION(aMultiMixedConv != nullptr, "null ptr");
1068 0 : if (! aMultiMixedConv)
1069 0 : return NS_ERROR_NULL_POINTER;
1070 :
1071 0 : *aMultiMixedConv = new nsMultiMixedConv();
1072 :
1073 0 : NS_ADDREF(*aMultiMixedConv);
1074 0 : return NS_OK;
1075 : }
|
