Issue #1288 - Part 1b: Rewrite nsHTTPCompressConv.

This also includes formatting changes.
This commit is contained in:
wolfbeast 2019-11-14 09:46:28 +01:00 • committed by Roy Tam
commit 0d109e3c9f
2 changed files with 466 additions and 405 deletions

View file

@ -20,7 +20,7 @@
// brotli headers // brotli headers
#include "state.h" #include "state.h"
#include "decode.h" #include "brotli/decode.h"
namespace mozilla { namespace mozilla {
namespace net { namespace net {
@ -33,7 +33,8 @@ NS_IMPL_ISUPPORTS(nsHTTPCompressConv,
nsIStreamConverter, nsIStreamConverter,
nsIStreamListener, nsIStreamListener,
nsIRequestObserver, nsIRequestObserver,
nsICompressConvStats) nsICompressConvStats,
nsIThreadRetargetableStreamListener)
// nsFTPDirListingConv methods // nsFTPDirListingConv methods
nsHTTPCompressConv::nsHTTPCompressConv() nsHTTPCompressConv::nsHTTPCompressConv()
@ -45,11 +46,14 @@ nsHTTPCompressConv::nsHTTPCompressConv()
, mCheckHeaderDone(false) , mCheckHeaderDone(false)
, mStreamEnded(false) , mStreamEnded(false)
, mStreamInitialized(false) , mStreamInitialized(false)
, mDummyStreamInitialised(false)
, d_stream{}
, mLen(0) , mLen(0)
, hMode(0) , hMode(0)
, mSkipCount(0) , mSkipCount(0)
, mFlags(0) , mFlags(0)
, mDecodedDataLength(0) , mDecodedDataLength(0)
, mMutex("nsHTTPCompressConv")
{ {
LOG(("nsHttpCompresssConv %p ctor\n", this)); LOG(("nsHttpCompresssConv %p ctor\n", this));
if (NS_IsMainThread()) { if (NS_IsMainThread()) {
@ -60,8 +64,7 @@ nsHTTPCompressConv::nsHTTPCompressConv()
} }
} }
nsHTTPCompressConv::~nsHTTPCompressConv() nsHTTPCompressConv::~nsHTTPCompressConv() {
{
LOG(("nsHttpCompresssConv %p dtor\n", this)); LOG(("nsHttpCompresssConv %p dtor\n", this));
if (mInpBuffer) { if (mInpBuffer) {
free(mInpBuffer); free(mInpBuffer);
@ -74,63 +77,64 @@ nsHTTPCompressConv::~nsHTTPCompressConv()
// For some reason we are not getting Z_STREAM_END. But this was also seen // For some reason we are not getting Z_STREAM_END. But this was also seen
// for mozilla bug 198133. Need to handle this case. // for mozilla bug 198133. Need to handle this case.
if (mStreamInitialized && !mStreamEnded) { if (mStreamInitialized && !mStreamEnded) {
inflateEnd (&d_stream); inflateEnd(&d_stream);
} }
} }
NS_IMETHODIMP NS_IMETHODIMP
nsHTTPCompressConv::GetDecodedDataLength(uint64_t *aDecodedDataLength) nsHTTPCompressConv::GetDecodedDataLength(uint64_t* aDecodedDataLength) {
{ *aDecodedDataLength = mDecodedDataLength;
*aDecodedDataLength = mDecodedDataLength;
return NS_OK;
}
NS_IMETHODIMP
nsHTTPCompressConv::AsyncConvertData(const char *aFromType,
const char *aToType,
nsIStreamListener *aListener,
nsISupports *aCtxt)
{
if (!PL_strncasecmp(aFromType, HTTP_COMPRESS_TYPE, sizeof(HTTP_COMPRESS_TYPE)-1) ||
!PL_strncasecmp(aFromType, HTTP_X_COMPRESS_TYPE, sizeof(HTTP_X_COMPRESS_TYPE)-1)) {
mMode = HTTP_COMPRESS_COMPRESS;
} else if (!PL_strncasecmp(aFromType, HTTP_GZIP_TYPE, sizeof(HTTP_GZIP_TYPE)-1) ||
!PL_strncasecmp(aFromType, HTTP_X_GZIP_TYPE, sizeof(HTTP_X_GZIP_TYPE)-1)) {
mMode = HTTP_COMPRESS_GZIP;
} else if (!PL_strncasecmp(aFromType, HTTP_DEFLATE_TYPE, sizeof(HTTP_DEFLATE_TYPE)-1)) {
mMode = HTTP_COMPRESS_DEFLATE;
} else if (!PL_strncasecmp(aFromType, HTTP_BROTLI_TYPE, sizeof(HTTP_BROTLI_TYPE)-1)) {
mMode = HTTP_COMPRESS_BROTLI;
}
LOG(("nsHttpCompresssConv %p AsyncConvertData %s %s mode %d\n",
this, aFromType, aToType, mMode));
// hook ourself up with the receiving listener.
mListener = aListener;
mAsyncConvContext = aCtxt;
return NS_OK; return NS_OK;
} }
NS_IMETHODIMP NS_IMETHODIMP
nsHTTPCompressConv::OnStartRequest(nsIRequest* request, nsISupports *aContext) nsHTTPCompressConv::AsyncConvertData(const char* aFromType, const char* aToType,
{ nsIStreamListener* aListener,
LOG(("nsHttpCompresssConv %p onstart\n", this)); nsISupports* aCtxt) {
return mListener->OnStartRequest(request, aContext); if (!PL_strncasecmp(aFromType, HTTP_COMPRESS_TYPE, sizeof(HTTP_COMPRESS_TYPE) - 1) ||
!PL_strncasecmp(aFromType, HTTP_X_COMPRESS_TYPE, sizeof(HTTP_X_COMPRESS_TYPE) - 1)) {
mMode = HTTP_COMPRESS_COMPRESS;
} else if (!PL_strncasecmp(aFromType, HTTP_GZIP_TYPE, sizeof(HTTP_GZIP_TYPE) - 1) ||
!PL_strncasecmp(aFromType, HTTP_X_GZIP_TYPE, sizeof(HTTP_X_GZIP_TYPE) - 1)) {
mMode = HTTP_COMPRESS_GZIP;
} else if (!PL_strncasecmp(aFromType, HTTP_DEFLATE_TYPE, sizeof(HTTP_DEFLATE_TYPE) - 1)) {
mMode = HTTP_COMPRESS_DEFLATE;
} else if (!PL_strncasecmp(aFromType, HTTP_BROTLI_TYPE, sizeof(HTTP_BROTLI_TYPE) - 1)) {
mMode = HTTP_COMPRESS_BROTLI;
}
LOG(("nsHttpCompresssConv %p AsyncConvertData %s %s mode %d\n", this,
aFromType, aToType, (CompressMode)mMode));
MutexAutoLock lock(mMutex);
// hook ourself up with the receiving listener.
mListener = aListener;
return NS_OK;
} }
NS_IMETHODIMP NS_IMETHODIMP
nsHTTPCompressConv::OnStopRequest(nsIRequest* request, nsISupports *aContext, nsHTTPCompressConv::OnStartRequest(nsIRequest* request, nsISupports* aContext) {
nsresult aStatus) LOG(("nsHttpCompresssConv %p onstart\n", this));
{ nsCOMPtr<nsIStreamListener> listener;
{
MutexAutoLock lock(mMutex);
listener = mListener;
}
return listener->OnStartRequest(request, aContext);
}
NS_IMETHODIMP
nsHTTPCompressConv::OnStopRequest(nsIRequest* request, nsISupports* aContext,
nsresult aStatus) {
nsresult status = aStatus; nsresult status = aStatus;
LOG(("nsHttpCompresssConv %p onstop %x\n", this, aStatus)); LOG(("nsHttpCompresssConv %p onstop %" PRIx32 "\n", this,
static_cast<uint32_t>(aStatus)));
// Framing integrity is enforced for content-encoding: gzip, but not for // Framing integrity is enforced for content-encoding: gzip, but not for
// content-encoding: deflate. Note that gzip vs deflate is NOT determined // content-encoding: deflate. Note that gzip vs deflate is NOT determined
// by content sniffing but only via header. // by content sniffing but only via header.
if (!mStreamEnded && NS_SUCCEEDED(status) && if (!mStreamEnded && NS_SUCCEEDED(status) &&
(mFailUncleanStops && (mMode == HTTP_COMPRESS_GZIP)) ) { (mFailUncleanStops && (mMode == HTTP_COMPRESS_GZIP))) {
// This is not a clean end of gzip stream: the transfer is incomplete. // This is not a clean end of gzip stream: the transfer is incomplete.
status = NS_ERROR_NET_PARTIAL_TRANSFER; status = NS_ERROR_NET_PARTIAL_TRANSFER;
LOG(("nsHttpCompresssConv %p onstop partial gzip\n", this)); LOG(("nsHttpCompresssConv %p onstop partial gzip\n", this));
@ -144,31 +148,40 @@ nsHTTPCompressConv::OnStopRequest(nsIRequest* request, nsISupports *aContext,
if (fpChannel && !isPending) { if (fpChannel && !isPending) {
fpChannel->ForcePending(true); fpChannel->ForcePending(true);
} }
if (mBrotli && (mBrotli->mTotalOut == 0) && !BrotliStateIsStreamEnd(&mBrotli->mState)) { if (mBrotli && (mBrotli->mTotalOut == 0) && !mBrotli->mBrotliStateIsStreamEnd) {
status = NS_ERROR_INVALID_CONTENT_ENCODING; status = NS_ERROR_INVALID_CONTENT_ENCODING;
} }
LOG(("nsHttpCompresssConv %p onstop brotlihandler rv %x\n", this, status)); LOG(("nsHttpCompresssConv %p onstop brotlihandler rv %" PRIx32 "\n", this,
static_cast<uint32_t>(status)));
if (fpChannel && !isPending) { if (fpChannel && !isPending) {
fpChannel->ForcePending(false); fpChannel->ForcePending(false);
} }
} }
return mListener->OnStopRequest(request, aContext, status);
nsCOMPtr<nsIStreamListener> listener;
{
MutexAutoLock lock(mMutex);
listener = mListener;
}
return listener->OnStopRequest(request, aContext, status);
} }
/* static */
/* static */ nsresult nsresult nsHTTPCompressConv::BrotliHandler(nsIInputStream* stream,
nsHTTPCompressConv::BrotliHandler(nsIInputStream *stream, void *closure, const char *dataIn, void* closure,
uint32_t, uint32_t aAvail, uint32_t *countRead) const char* dataIn,
{ uint32_t,
uint32_t aAvail,
uint32_t* countRead) {
MOZ_ASSERT(stream); MOZ_ASSERT(stream);
nsHTTPCompressConv *self = static_cast<nsHTTPCompressConv *>(closure); nsHTTPCompressConv* self = static_cast<nsHTTPCompressConv*>(closure);
*countRead = 0; *countRead = 0;
const size_t kOutSize = 128 * 1024; // just a chunk size, we call in a loop const size_t kOutSize = 128 * 1024; // just a chunk size, we call in a loop
uint8_t *outPtr; uint8_t* outPtr;
size_t outSize; size_t outSize;
size_t avail = aAvail; size_t avail = aAvail;
BrotliResult res; BrotliDecoderResult res;
if (!self->mBrotli) { if (!self->mBrotli) {
*countRead = aAvail; *countRead = aAvail;
@ -186,15 +199,21 @@ nsHTTPCompressConv::BrotliHandler(nsIInputStream *stream, void *closure, const c
outPtr = outBuffer.get(); outPtr = outBuffer.get();
// brotli api is documented in brotli/dec/decode.h and brotli/dec/decode.c // brotli api is documented in brotli/dec/decode.h and brotli/dec/decode.c
LOG(("nsHttpCompresssConv %p brotlihandler decompress %d\n", self, avail)); LOG(("nsHttpCompresssConv %p brotlihandler decompress %zu\n", self, avail));
res = ::BrotliDecompressStream( size_t totalOut = self->mBrotli->mTotalOut;
&avail, reinterpret_cast<const unsigned char **>(&dataIn), res = ::BrotliDecoderDecompressStream(
&outSize, &outPtr, &self->mBrotli->mTotalOut, &self->mBrotli->mState); &self->mBrotli->mState, &avail,
reinterpret_cast<const unsigned char**>(&dataIn), &outSize, &outPtr,
&totalOut);
outSize = kOutSize - outSize; outSize = kOutSize - outSize;
LOG(("nsHttpCompresssConv %p brotlihandler decompress rv=%x out=%d\n", self->mBrotli->mTotalOut = totalOut;
self, res, outSize)); self->mBrotli->mBrotliStateIsStreamEnd =
BrotliDecoderIsFinished(&self->mBrotli->mState);
LOG(("nsHttpCompresssConv %p brotlihandler decompress rv=%" PRIx32
" out=%zu\n",
self, static_cast<uint32_t>(res), outSize));
if (res == BROTLI_RESULT_ERROR) { if (res == BROTLI_DECODER_RESULT_ERROR) {
LOG(("nsHttpCompressConv %p marking invalid encoding", self)); LOG(("nsHttpCompressConv %p marking invalid encoding", self));
self->mBrotli->mStatus = NS_ERROR_INVALID_CONTENT_ENCODING; self->mBrotli->mStatus = NS_ERROR_INVALID_CONTENT_ENCODING;
return self->mBrotli->mStatus; return self->mBrotli->mStatus;
@ -202,7 +221,7 @@ nsHTTPCompressConv::BrotliHandler(nsIInputStream *stream, void *closure, const c
// in 'the current implementation' brotli must consume everything before // in 'the current implementation' brotli must consume everything before
// asking for more input // asking for more input
if (res == BROTLI_RESULT_NEEDS_MORE_INPUT) { if (res == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT) {
MOZ_ASSERT(!avail); MOZ_ASSERT(!avail);
if (avail) { if (avail) {
LOG(("nsHttpCompressConv %p did not consume all input", self)); LOG(("nsHttpCompressConv %p did not consume all input", self));
@ -214,22 +233,23 @@ nsHTTPCompressConv::BrotliHandler(nsIInputStream *stream, void *closure, const c
nsresult rv = self->do_OnDataAvailable(self->mBrotli->mRequest, nsresult rv = self->do_OnDataAvailable(self->mBrotli->mRequest,
self->mBrotli->mContext, self->mBrotli->mContext,
self->mBrotli->mSourceOffset, self->mBrotli->mSourceOffset,
reinterpret_cast<const char *>(outBuffer.get()), reinterpret_cast<const char*>(outBuffer.get()),
outSize); outSize);
LOG(("nsHttpCompressConv %p BrotliHandler ODA rv=%x", self, rv)); LOG(("nsHttpCompressConv %p BrotliHandler ODA rv=%" PRIx32, self,
static_cast<uint32_t>(rv)));
if (NS_FAILED(rv)) { if (NS_FAILED(rv)) {
self->mBrotli->mStatus = rv; self->mBrotli->mStatus = rv;
return self->mBrotli->mStatus; return self->mBrotli->mStatus;
} }
} }
if (res == BROTLI_RESULT_SUCCESS || if (res == BROTLI_DECODER_RESULT_SUCCESS ||
res == BROTLI_RESULT_NEEDS_MORE_INPUT) { res == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT) {
*countRead = aAvail; *countRead = aAvail;
return NS_OK; return NS_OK;
} }
MOZ_ASSERT (res == BROTLI_RESULT_NEEDS_MORE_OUTPUT); MOZ_ASSERT(res == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT);
} while (res == BROTLI_RESULT_NEEDS_MORE_OUTPUT); } while (res == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT);
self->mBrotli->mStatus = NS_ERROR_UNEXPECTED; self->mBrotli->mStatus = NS_ERROR_UNEXPECTED;
return self->mBrotli->mStatus; return self->mBrotli->mStatus;
@ -237,11 +257,10 @@ nsHTTPCompressConv::BrotliHandler(nsIInputStream *stream, void *closure, const c
NS_IMETHODIMP NS_IMETHODIMP
nsHTTPCompressConv::OnDataAvailable(nsIRequest* request, nsHTTPCompressConv::OnDataAvailable(nsIRequest* request,
nsISupports *aContext, nsISupports* aContext,
nsIInputStream *iStr, nsIInputStream* iStr,
uint64_t aSourceOffset, uint64_t aSourceOffset,
uint32_t aCount) uint32_t aCount) {
{
nsresult rv = NS_ERROR_INVALID_CONTENT_ENCODING; nsresult rv = NS_ERROR_INVALID_CONTENT_ENCODING;
uint32_t streamLen = aCount; uint32_t streamLen = aCount;
LOG(("nsHttpCompressConv %p OnDataAvailable %d", this, aCount)); LOG(("nsHttpCompressConv %p OnDataAvailable %d", this, aCount));
@ -260,206 +279,216 @@ nsHTTPCompressConv::OnDataAvailable(nsIRequest* request,
} }
switch (mMode) { switch (mMode) {
case HTTP_COMPRESS_GZIP: case HTTP_COMPRESS_GZIP:
streamLen = check_header(iStr, streamLen, &rv); streamLen = check_header(iStr, streamLen, &rv);
if (rv != NS_OK) { if (rv != NS_OK) {
return rv; return rv;
} }
if (streamLen == 0) { if (streamLen == 0) {
return NS_OK; return NS_OK;
} }
MOZ_FALLTHROUGH; MOZ_FALLTHROUGH;
case HTTP_COMPRESS_DEFLATE: case HTTP_COMPRESS_DEFLATE:
if (mInpBuffer != nullptr && streamLen > mInpBufferLen) { if (mInpBuffer != nullptr && streamLen > mInpBufferLen) {
mInpBuffer = (unsigned char *) realloc(mInpBuffer, mInpBufferLen = streamLen); unsigned char* originalInpBuffer = mInpBuffer;
if (!(mInpBuffer = (unsigned char*)realloc(originalInpBuffer, mInpBufferLen = streamLen))) {
free(originalInpBuffer);
}
if (mOutBufferLen < streamLen * 2) { if (mOutBufferLen < streamLen * 2) {
mOutBuffer = (unsigned char *) realloc(mOutBuffer, mOutBufferLen = streamLen * 3); unsigned char* originalOutBuffer = mOutBuffer;
if (!(mOutBuffer = (unsigned char*)realloc(mOutBuffer, mOutBufferLen = streamLen * 3))) {
free(originalOutBuffer);
}
}
if (mInpBuffer == nullptr || mOutBuffer == nullptr) {
return NS_ERROR_OUT_OF_MEMORY;
}
}
if (mInpBuffer == nullptr) {
mInpBuffer = (unsigned char*)malloc(mInpBufferLen = streamLen);
}
if (mOutBuffer == nullptr) {
mOutBuffer = (unsigned char*)malloc(mOutBufferLen = streamLen * 3);
} }
if (mInpBuffer == nullptr || mOutBuffer == nullptr) { if (mInpBuffer == nullptr || mOutBuffer == nullptr) {
return NS_ERROR_OUT_OF_MEMORY; return NS_ERROR_OUT_OF_MEMORY;
} }
}
if (mInpBuffer == nullptr) { uint32_t unused;
mInpBuffer = (unsigned char *) malloc(mInpBufferLen = streamLen); iStr->Read((char*)mInpBuffer, streamLen, &unused);
}
if (mOutBuffer == nullptr) { if (mMode == HTTP_COMPRESS_DEFLATE) {
mOutBuffer = (unsigned char *) malloc(mOutBufferLen = streamLen * 3); if (!mStreamInitialized) {
} memset(&d_stream, 0, sizeof(d_stream));
if (mInpBuffer == nullptr || mOutBuffer == nullptr) { if (inflateInit(&d_stream) != Z_OK) {
return NS_ERROR_OUT_OF_MEMORY;
}
uint32_t unused;
iStr->Read((char *)mInpBuffer, streamLen, &unused);
if (mMode == HTTP_COMPRESS_DEFLATE) {
if (!mStreamInitialized) {
memset(&d_stream, 0, sizeof (d_stream));
if (inflateInit(&d_stream) != Z_OK) {
return NS_ERROR_FAILURE;
}
mStreamInitialized = true;
}
d_stream.next_in = mInpBuffer;
d_stream.avail_in = (uInt)streamLen;
mDummyStreamInitialised = false;
for (;;) {
d_stream.next_out = mOutBuffer;
d_stream.avail_out = (uInt)mOutBufferLen;
int code = inflate(&d_stream, Z_NO_FLUSH);
unsigned bytesWritten = (uInt)mOutBufferLen - d_stream.avail_out;
if (code == Z_STREAM_END) {
if (bytesWritten) {
rv = do_OnDataAvailable(request, aContext, aSourceOffset, (char *)mOutBuffer, bytesWritten);
if (NS_FAILED (rv)) {
return rv;
}
}
inflateEnd(&d_stream);
mStreamEnded = true;
break;
} else if (code == Z_OK) {
if (bytesWritten) {
rv = do_OnDataAvailable(request, aContext, aSourceOffset, (char *)mOutBuffer, bytesWritten);
if (NS_FAILED (rv)) {
return rv;
}
}
} else if (code == Z_BUF_ERROR) {
if (bytesWritten) {
rv = do_OnDataAvailable(request, aContext, aSourceOffset, (char *)mOutBuffer, bytesWritten);
if (NS_FAILED (rv)) {
return rv;
}
}
break;
} else if (code == Z_DATA_ERROR) {
// some servers (notably Apache with mod_deflate) don't generate zlib headers
// insert a dummy header and try again
static char dummy_head[2] =
{
0x8 + 0x7 * 0x10,
(((0x8 + 0x7 * 0x10) * 0x100 + 30) / 31 * 31) & 0xFF,
};
inflateReset(&d_stream);
d_stream.next_in = (Bytef*) dummy_head;
d_stream.avail_in = sizeof(dummy_head);
code = inflate(&d_stream, Z_NO_FLUSH);
if (code != Z_OK) {
return NS_ERROR_FAILURE; return NS_ERROR_FAILURE;
} }
// stop an endless loop caused by non-deflate data being labelled as deflate mStreamInitialized = true;
if (mDummyStreamInitialised) { }
NS_WARNING("endless loop detected" d_stream.next_in = mInpBuffer;
" - invalid deflate"); d_stream.avail_in = (uInt)streamLen;
mDummyStreamInitialised = false;
for (;;) {
d_stream.next_out = mOutBuffer;
d_stream.avail_out = (uInt)mOutBufferLen;
int code = inflate(&d_stream, Z_NO_FLUSH);
unsigned bytesWritten = (uInt)mOutBufferLen - d_stream.avail_out;
if (code == Z_STREAM_END) {
if (bytesWritten) {
rv = do_OnDataAvailable(request, aContext, aSourceOffset, (char*)mOutBuffer, bytesWritten);
if (NS_FAILED(rv)) {
return rv;
}
}
inflateEnd(&d_stream);
mStreamEnded = true;
break;
} else if (code == Z_OK) {
if (bytesWritten) {
rv = do_OnDataAvailable(request, aContext, aSourceOffset, (char*)mOutBuffer, bytesWritten);
if (NS_FAILED(rv)) {
return rv;
}
}
} else if (code == Z_BUF_ERROR) {
if (bytesWritten) {
rv = do_OnDataAvailable(request, aContext, aSourceOffset, (char*)mOutBuffer, bytesWritten);
if (NS_FAILED(rv)) {
return rv;
}
}
break;
} else if (code == Z_DATA_ERROR) {
// some servers (notably Apache with mod_deflate) don't generate
// zlib headers insert a dummy header and try again
static char dummy_head[2] = {
0x8 + 0x7 * 0x10,
(((0x8 + 0x7 * 0x10) * 0x100 + 30) / 31 * 31) & 0xFF,
};
inflateReset(&d_stream);
d_stream.next_in = (Bytef*)dummy_head;
d_stream.avail_in = sizeof(dummy_head);
code = inflate(&d_stream, Z_NO_FLUSH);
if (code != Z_OK) {
return NS_ERROR_FAILURE;
}
// stop an endless loop caused by non-deflate data being labelled as
// deflate
if (mDummyStreamInitialised) {
NS_WARNING(
"endless loop detected"
" - invalid deflate");
return NS_ERROR_INVALID_CONTENT_ENCODING;
}
mDummyStreamInitialised = true;
// reset stream pointers to our original data
d_stream.next_in = mInpBuffer;
d_stream.avail_in = (uInt)streamLen;
} else {
return NS_ERROR_INVALID_CONTENT_ENCODING; return NS_ERROR_INVALID_CONTENT_ENCODING;
} }
mDummyStreamInitialised = true; } /* for */
// reset stream pointers to our original data } else {
d_stream.next_in = mInpBuffer; if (!mStreamInitialized) {
d_stream.avail_in = (uInt)streamLen; memset(&d_stream, 0, sizeof(d_stream));
} else {
return NS_ERROR_INVALID_CONTENT_ENCODING;
}
} /* for */
} else {
if (!mStreamInitialized) {
memset(&d_stream, 0, sizeof (d_stream));
if (inflateInit2(&d_stream, -MAX_WBITS) != Z_OK) { if (inflateInit2(&d_stream, -MAX_WBITS) != Z_OK) {
return NS_ERROR_FAILURE; return NS_ERROR_FAILURE;
}
mStreamInitialized = true;
} }
mStreamInitialized = true; d_stream.next_in = mInpBuffer;
d_stream.avail_in = (uInt)streamLen;
for (;;) {
d_stream.next_out = mOutBuffer;
d_stream.avail_out = (uInt)mOutBufferLen;
int code = inflate(&d_stream, Z_NO_FLUSH);
unsigned bytesWritten = (uInt)mOutBufferLen - d_stream.avail_out;
if (code == Z_STREAM_END) {
if (bytesWritten) {
rv = do_OnDataAvailable(request, aContext, aSourceOffset, (char*)mOutBuffer, bytesWritten);
if (NS_FAILED(rv)) {
return rv;
}
}
inflateEnd(&d_stream);
mStreamEnded = true;
break;
} else if (code == Z_OK) {
if (bytesWritten) {
rv = do_OnDataAvailable(request, aContext, aSourceOffset, (char*)mOutBuffer, bytesWritten);
if (NS_FAILED(rv)) {
return rv;
}
}
} else if (code == Z_BUF_ERROR) {
if (bytesWritten) {
rv = do_OnDataAvailable(request, aContext, aSourceOffset, (char*)mOutBuffer, bytesWritten);
if (NS_FAILED(rv)) {
return rv;
}
}
break;
} else {
return NS_ERROR_INVALID_CONTENT_ENCODING;
}
} /* for */
} /* gzip */
break;
case HTTP_COMPRESS_BROTLI: {
if (!mBrotli) {
mBrotli = new BrotliWrapper();
} }
d_stream.next_in = mInpBuffer; mBrotli->mRequest = request;
d_stream.avail_in = (uInt)streamLen; mBrotli->mContext = nullptr;
mBrotli->mSourceOffset = aSourceOffset;
for (;;) { uint32_t countRead;
d_stream.next_out = mOutBuffer; rv = iStr->ReadSegments(BrotliHandler, this, streamLen, &countRead);
d_stream.avail_out = (uInt)mOutBufferLen; if (NS_SUCCEEDED(rv)) {
rv = mBrotli->mStatus;
}
if (NS_FAILED(rv)) {
return rv;
}
} break;
int code = inflate (&d_stream, Z_NO_FLUSH); default:
unsigned bytesWritten = (uInt)mOutBufferLen - d_stream.avail_out; nsCOMPtr<nsIStreamListener> listener;
{
if (code == Z_STREAM_END) { MutexAutoLock lock(mMutex);
if (bytesWritten) { listener = mListener;
rv = do_OnDataAvailable(request, aContext, aSourceOffset, (char *)mOutBuffer, bytesWritten); }
if (NS_FAILED (rv)) { rv = listener->OnDataAvailable(request, aContext, iStr, aSourceOffset, aCount);
return rv; if (NS_FAILED(rv)) {
} return rv;
} }
inflateEnd(&d_stream);
mStreamEnded = true;
break;
} else if (code == Z_OK) {
if (bytesWritten) {
rv = do_OnDataAvailable(request, aContext, aSourceOffset, (char *)mOutBuffer, bytesWritten);
if (NS_FAILED (rv)) {
return rv;
}
}
} else if (code == Z_BUF_ERROR) {
if (bytesWritten) {
rv = do_OnDataAvailable(request, aContext, aSourceOffset, (char *)mOutBuffer, bytesWritten);
if (NS_FAILED (rv)) {
return rv;
}
}
break;
} else {
return NS_ERROR_INVALID_CONTENT_ENCODING;
}
} /* for */
} /* gzip */
break;
case HTTP_COMPRESS_BROTLI:
{
if (!mBrotli) {
mBrotli = new BrotliWrapper();
}
mBrotli->mRequest = request;
mBrotli->mContext = aContext;
mBrotli->mSourceOffset = aSourceOffset;
uint32_t countRead;
rv = iStr->ReadSegments(BrotliHandler, this, streamLen, &countRead);
if (NS_SUCCEEDED(rv)) {
rv = mBrotli->mStatus;
}
if (NS_FAILED(rv)) {
return rv;
}
}
break;
default:
rv = mListener->OnDataAvailable(request, aContext, iStr, aSourceOffset, aCount);
if (NS_FAILED (rv)) {
return rv;
}
} /* switch */ } /* switch */
return NS_OK; return NS_OK;
@ -468,20 +497,19 @@ nsHTTPCompressConv::OnDataAvailable(nsIRequest* request,
// XXX/ruslan: need to implement this too // XXX/ruslan: need to implement this too
NS_IMETHODIMP NS_IMETHODIMP
nsHTTPCompressConv::Convert(nsIInputStream *aFromStream, nsHTTPCompressConv::Convert(nsIInputStream* aFromStream,
const char *aFromType, const char* aFromType,
const char *aToType, const char* aToType,
nsISupports *aCtxt, nsISupports* aCtxt,
nsIInputStream **_retval) nsIInputStream** _retval) {
{
return NS_ERROR_NOT_IMPLEMENTED; return NS_ERROR_NOT_IMPLEMENTED;
} }
nsresult nsresult nsHTTPCompressConv::do_OnDataAvailable(nsIRequest* request,
nsHTTPCompressConv::do_OnDataAvailable(nsIRequest* request, nsISupports* context,
nsISupports *context, uint64_t offset, uint64_t offset,
const char *buffer, uint32_t count) const char* buffer,
{ uint32_t count) {
if (!mStream) { if (!mStream) {
mStream = do_CreateInstance(NS_STRINGINPUTSTREAM_CONTRACTID); mStream = do_CreateInstance(NS_STRINGINPUTSTREAM_CONTRACTID);
NS_ENSURE_STATE(mStream); NS_ENSURE_STATE(mStream);
@ -489,8 +517,12 @@ nsHTTPCompressConv::do_OnDataAvailable(nsIRequest* request,
mStream->ShareData(buffer, count); mStream->ShareData(buffer, count);
nsresult rv = mListener->OnDataAvailable(request, context, mStream, nsCOMPtr<nsIStreamListener> listener;
offset, count); {
MutexAutoLock lock(mMutex);
listener = mListener;
}
nsresult rv = listener->OnDataAvailable(request, context, mStream, offset, count);
// Make sure the stream no longer references |buffer| in case our listener // Make sure the stream no longer references |buffer| in case our listener
// is crazy enough to try to read from |mStream| after ODA. // is crazy enough to try to read from |mStream| after ODA.
@ -500,19 +532,27 @@ nsHTTPCompressConv::do_OnDataAvailable(nsIRequest* request,
return rv; return rv;
} }
#define ASCII_FLAG 0x01 /* bit 0 set: file probably ascii text */ #define ASCII_FLAG 0x01 /* bit 0 set: file probably ascii text */
#define HEAD_CRC 0x02 /* bit 1 set: header CRC present */ #define HEAD_CRC 0x02 /* bit 1 set: header CRC present */
#define EXTRA_FIELD 0x04 /* bit 2 set: extra field present */ #define EXTRA_FIELD 0x04 /* bit 2 set: extra field present */
#define ORIG_NAME 0x08 /* bit 3 set: original file name present */ #define ORIG_NAME 0x08 /* bit 3 set: original file name present */
#define COMMENT 0x10 /* bit 4 set: file comment present */ #define COMMENT 0x10 /* bit 4 set: file comment present */
#define RESERVED 0xE0 /* bits 5..7: reserved */ #define RESERVED 0xE0 /* bits 5..7: reserved */
static unsigned gz_magic[2] = {0x1f, 0x8b}; /* gzip magic header */ static unsigned gz_magic[2] = {0x1f, 0x8b}; /* gzip magic header */
uint32_t uint32_t nsHTTPCompressConv::check_header(nsIInputStream* iStr,
nsHTTPCompressConv::check_header(nsIInputStream *iStr, uint32_t streamLen, nsresult *rs) uint32_t streamLen, nsresult* rs) {
{ enum {
enum { GZIP_INIT = 0, GZIP_OS, GZIP_EXTRA0, GZIP_EXTRA1, GZIP_EXTRA2, GZIP_ORIG, GZIP_COMMENT, GZIP_CRC }; GZIP_INIT = 0,
GZIP_OS,
GZIP_EXTRA0,
GZIP_EXTRA1,
GZIP_EXTRA2,
GZIP_ORIG,
GZIP_COMMENT,
GZIP_CRC
};
char c; char c;
*rs = NS_OK; *rs = NS_OK;
@ -523,134 +563,147 @@ nsHTTPCompressConv::check_header(nsIInputStream *iStr, uint32_t streamLen, nsres
while (streamLen) { while (streamLen) {
switch (hMode) { switch (hMode) {
case GZIP_INIT: case GZIP_INIT:
uint32_t unused; uint32_t unused;
iStr->Read(&c, 1, &unused); iStr->Read(&c, 1, &unused);
streamLen--; streamLen--;
if (mSkipCount == 0 && ((unsigned)c & 0377) != gz_magic[0]) { if (mSkipCount == 0 && ((unsigned)c & 0377) != gz_magic[0]) {
*rs = NS_ERROR_INVALID_CONTENT_ENCODING;
return 0;
}
if (mSkipCount == 1 && ((unsigned)c & 0377) != gz_magic[1]) {
*rs = NS_ERROR_INVALID_CONTENT_ENCODING;
return 0;
}
if (mSkipCount == 2 && ((unsigned)c & 0377) != Z_DEFLATED) {
*rs = NS_ERROR_INVALID_CONTENT_ENCODING;
return 0;
}
mSkipCount++;
if (mSkipCount == 4) {
mFlags = (unsigned) c & 0377;
if (mFlags & RESERVED) {
*rs = NS_ERROR_INVALID_CONTENT_ENCODING; *rs = NS_ERROR_INVALID_CONTENT_ENCODING;
return 0; return 0;
} }
hMode = GZIP_OS;
mSkipCount = 0;
}
break;
case GZIP_OS: if (mSkipCount == 1 && ((unsigned)c & 0377) != gz_magic[1]) {
iStr->Read(&c, 1, &unused); *rs = NS_ERROR_INVALID_CONTENT_ENCODING;
streamLen--; return 0;
mSkipCount++; }
if (mSkipCount == 6) { if (mSkipCount == 2 && ((unsigned)c & 0377) != Z_DEFLATED) {
hMode = GZIP_EXTRA0; *rs = NS_ERROR_INVALID_CONTENT_ENCODING;
} return 0;
break; }
case GZIP_EXTRA0: mSkipCount++;
if (mFlags & EXTRA_FIELD) { if (mSkipCount == 4) {
iStr->Read(&c, 1, &unused); mFlags = (unsigned)c & 0377;
streamLen--; if (mFlags & RESERVED) {
mLen = (uInt) c & 0377; *rs = NS_ERROR_INVALID_CONTENT_ENCODING;
hMode = GZIP_EXTRA1; return 0;
} else { }
hMode = GZIP_ORIG; hMode = GZIP_OS;
} mSkipCount = 0;
break; }
break;
case GZIP_EXTRA1: case GZIP_OS:
iStr->Read(&c, 1, &unused);
streamLen--;
mLen |= ((uInt) c & 0377) << 8;
mSkipCount = 0;
hMode = GZIP_EXTRA2;
break;
case GZIP_EXTRA2:
if (mSkipCount == mLen) {
hMode = GZIP_ORIG;
} else {
iStr->Read(&c, 1, &unused); iStr->Read(&c, 1, &unused);
streamLen--; streamLen--;
mSkipCount++; mSkipCount++;
}
break;
case GZIP_ORIG: if (mSkipCount == 6) {
if (mFlags & ORIG_NAME) { hMode = GZIP_EXTRA0;
}
break;
case GZIP_EXTRA0:
if (mFlags & EXTRA_FIELD) {
iStr->Read(&c, 1, &unused);
streamLen--;
mLen = (uInt)c & 0377;
hMode = GZIP_EXTRA1;
} else {
hMode = GZIP_ORIG;
}
break;
case GZIP_EXTRA1:
iStr->Read(&c, 1, &unused); iStr->Read(&c, 1, &unused);
streamLen--; streamLen--;
if (c == 0) mLen |= ((uInt)c & 0377) << 8;
mSkipCount = 0;
hMode = GZIP_EXTRA2;
break;
case GZIP_EXTRA2:
if (mSkipCount == mLen) {
hMode = GZIP_ORIG;
} else {
iStr->Read(&c, 1, &unused);
streamLen--;
mSkipCount++;
}
break;
case GZIP_ORIG:
if (mFlags & ORIG_NAME) {
iStr->Read(&c, 1, &unused);
streamLen--;
if (c == 0) hMode = GZIP_COMMENT;
} else {
hMode = GZIP_COMMENT; hMode = GZIP_COMMENT;
} else { }
hMode = GZIP_COMMENT; break;
}
break;
case GZIP_COMMENT: case GZIP_COMMENT:
if (mFlags & COMMENT) { if (mFlags & COMMENT) {
iStr->Read(&c, 1, &unused); iStr->Read(&c, 1, &unused);
streamLen--; streamLen--;
if (c == 0) { if (c == 0) {
hMode = GZIP_CRC;
mSkipCount = 0;
}
} else {
hMode = GZIP_CRC; hMode = GZIP_CRC;
mSkipCount = 0; mSkipCount = 0;
} }
} else { break;
hMode = GZIP_CRC;
mSkipCount = 0;
}
break;
case GZIP_CRC: case GZIP_CRC:
if (mFlags & HEAD_CRC) { if (mFlags & HEAD_CRC) {
iStr->Read(&c, 1, &unused); iStr->Read(&c, 1, &unused);
streamLen--; streamLen--;
mSkipCount++; mSkipCount++;
if (mSkipCount == 2) { if (mSkipCount == 2) {
mCheckHeaderDone = true;
return streamLen;
}
} else {
mCheckHeaderDone = true; mCheckHeaderDone = true;
return streamLen; return streamLen;
} }
} else { break;
mCheckHeaderDone = true;
return streamLen;
}
break;
} }
} }
return streamLen; return streamLen;
} }
} // namespace net NS_IMETHODIMP
} // namespace mozilla nsHTTPCompressConv::CheckListenerChain() {
nsCOMPtr<nsIThreadRetargetableStreamListener> listener;
{
MutexAutoLock lock(mMutex);
listener = do_QueryInterface(mListener);
}
nsresult if (!listener) {
NS_NewHTTPCompressConv(mozilla::net::nsHTTPCompressConv **aHTTPCompressConv) return NS_ERROR_NO_INTERFACE;
{ }
NS_PRECONDITION(aHTTPCompressConv != nullptr, "null ptr");
return listener->CheckListenerChain();
}
} // namespace net
} // namespace mozilla
nsresult NS_NewHTTPCompressConv(
mozilla::net::nsHTTPCompressConv** aHTTPCompressConv) {
MOZ_ASSERT(aHTTPCompressConv != nullptr, "null ptr");
if (!aHTTPCompressConv) { if (!aHTTPCompressConv) {
return NS_ERROR_NULL_POINTER; return NS_ERROR_NULL_POINTER;
} }
RefPtr<mozilla::net::nsHTTPCompressConv> outVal = RefPtr<mozilla::net::nsHTTPCompressConv> outVal =
new mozilla::net::nsHTTPCompressConv(); new mozilla::net::nsHTTPCompressConv();
if (!outVal) { if (!outVal) {
return NS_ERROR_OUT_OF_MEMORY; return NS_ERROR_OUT_OF_MEMORY;
} }

View file

@ -4,13 +4,16 @@
* License, v. 2.0. If a copy of the MPL was not distributed with this * License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#if !defined (__nsHTTPCompressConv__h__) #if !defined(__nsHTTPCompressConv__h__)
#define __nsHTTPCompressConv__h__ 1 #define __nsHTTPCompressConv__h__ 1
#include "nsIStreamConverter.h" #include "nsIStreamConverter.h"
#include "nsICompressConvStats.h" #include "nsICompressConvStats.h"
#include "nsIThreadRetargetableStreamListener.h"
#include "nsCOMPtr.h" #include "nsCOMPtr.h"
#include "nsAutoPtr.h" #include "nsAutoPtr.h"
#include "mozilla/Atomics.h"
#include "mozilla/Mutex.h"
#include "zlib.h" #include "zlib.h"
@ -30,20 +33,19 @@ class nsIStringInputStream;
{0xab, 0xf4, 0x07, 0x98, 0x61, 0x51, 0x02, 0x2d} \ {0xab, 0xf4, 0x07, 0x98, 0x61, 0x51, 0x02, 0x2d} \
} }
#define HTTP_DEFLATE_TYPE "deflate"
#define HTTP_DEFLATE_TYPE "deflate" #define HTTP_GZIP_TYPE "gzip"
#define HTTP_GZIP_TYPE "gzip" #define HTTP_X_GZIP_TYPE "x-gzip"
#define HTTP_X_GZIP_TYPE "x-gzip" #define HTTP_COMPRESS_TYPE "compress"
#define HTTP_COMPRESS_TYPE "compress" #define HTTP_X_COMPRESS_TYPE "x-compress"
#define HTTP_X_COMPRESS_TYPE "x-compress" #define HTTP_BROTLI_TYPE "br"
#define HTTP_BROTLI_TYPE "br" #define HTTP_IDENTITY_TYPE "identity"
#define HTTP_IDENTITY_TYPE "identity" #define HTTP_UNCOMPRESSED_TYPE "uncompressed"
#define HTTP_UNCOMPRESSED_TYPE "uncompressed"
namespace mozilla { namespace mozilla {
namespace net { namespace net {
typedef enum { typedef enum {
HTTP_COMPRESS_GZIP, HTTP_COMPRESS_GZIP,
HTTP_COMPRESS_DEFLATE, HTTP_COMPRESS_DEFLATE,
HTTP_COMPRESS_COMPRESS, HTTP_COMPRESS_COMPRESS,
@ -51,82 +53,88 @@ typedef enum {
HTTP_COMPRESS_IDENTITY HTTP_COMPRESS_IDENTITY
} CompressMode; } CompressMode;
class BrotliWrapper class BrotliWrapper {
{
public: public:
BrotliWrapper() BrotliWrapper()
: mTotalOut(0) : mTotalOut(0),
, mStatus(NS_OK) mStatus(NS_OK),
{ mBrotliStateIsStreamEnd(false),
BrotliStateInit(&mState); mRequest(nullptr),
} mContext(nullptr),
~BrotliWrapper() mSourceOffset(0) {
{ BrotliDecoderStateInit(&mState, 0, 0, 0);
BrotliStateCleanup(&mState);
} }
~BrotliWrapper() { BrotliDecoderStateCleanup(&mState); }
BrotliState mState; BrotliDecoderState mState;
size_t mTotalOut; Atomic<size_t, Relaxed> mTotalOut;
nsresult mStatus; nsresult mStatus;
Atomic<bool, Relaxed> mBrotliStateIsStreamEnd;
nsIRequest *mRequest; nsIRequest* mRequest;
nsISupports *mContext; nsISupports* mContext;
uint64_t mSourceOffset; uint64_t mSourceOffset;
}; };
class nsHTTPCompressConv class nsHTTPCompressConv : public nsIStreamConverter,
: public nsIStreamConverter public nsICompressConvStats,
, public nsICompressConvStats public nsIThreadRetargetableStreamListener {
{ public:
public:
// nsISupports methods // nsISupports methods
NS_DECL_THREADSAFE_ISUPPORTS NS_DECL_THREADSAFE_ISUPPORTS
NS_DECL_NSIREQUESTOBSERVER NS_DECL_NSIREQUESTOBSERVER
NS_DECL_NSISTREAMLISTENER NS_DECL_NSISTREAMLISTENER
NS_DECL_NSICOMPRESSCONVSTATS NS_DECL_NSICOMPRESSCONVSTATS
NS_DECL_NSITHREADRETARGETABLESTREAMLISTENER
// nsIStreamConverter methods // nsIStreamConverter methods
NS_DECL_NSISTREAMCONVERTER NS_DECL_NSISTREAMCONVERTER
nsHTTPCompressConv (); nsHTTPCompressConv();
private: private:
virtual ~nsHTTPCompressConv (); virtual ~nsHTTPCompressConv();
nsCOMPtr<nsIStreamListener> mListener; // this guy gets the converted data via his OnDataAvailable () nsCOMPtr<nsIStreamListener> mListener; // this guy gets the converted data via his OnDataAvailable ()
CompressMode mMode; Atomic<CompressMode, Relaxed> mMode;
unsigned char *mOutBuffer; unsigned char* mOutBuffer;
unsigned char *mInpBuffer; unsigned char* mInpBuffer;
uint32_t mOutBufferLen; uint32_t mOutBufferLen;
uint32_t mInpBufferLen; uint32_t mInpBufferLen;
nsAutoPtr<BrotliWrapper> mBrotli; nsAutoPtr<BrotliWrapper> mBrotli;
nsCOMPtr<nsISupports> mAsyncConvContext; nsCOMPtr<nsIStringInputStream> mStream;
nsCOMPtr<nsIStringInputStream> mStream;
static nsresult static nsresult BrotliHandler(nsIInputStream* stream,
BrotliHandler(nsIInputStream *stream, void *closure, const char *dataIn, void* closure,
uint32_t, uint32_t avail, uint32_t *countRead); const char* dataIn,
uint32_t,
uint32_t avail,
uint32_t* countRead);
nsresult do_OnDataAvailable (nsIRequest *request, nsISupports *aContext, nsresult do_OnDataAvailable(nsIRequest* request,
uint64_t aSourceOffset, const char *buffer, nsISupports* aContext,
uint32_t aCount); uint64_t aSourceOffset,
const char* buffer,
uint32_t aCount);
bool mCheckHeaderDone; bool mCheckHeaderDone;
bool mStreamEnded; Atomic<bool> mStreamEnded;
bool mStreamInitialized; bool mStreamInitialized;
bool mDummyStreamInitialised; bool mDummyStreamInitialised;
bool mFailUncleanStops; bool mFailUncleanStops;
z_stream d_stream; z_stream d_stream;
unsigned mLen, hMode, mSkipCount, mFlags; unsigned mLen, hMode, mSkipCount, mFlags;
uint32_t check_header (nsIInputStream *iStr, uint32_t streamLen, nsresult *rv); uint32_t check_header(nsIInputStream* iStr, uint32_t streamLen, nsresult* rv);
uint32_t mDecodedDataLength; Atomic<uint32_t, Relaxed> mDecodedDataLength;
mutable mozilla::Mutex mMutex;
}; };
} // namespace net } // namespace net