wine/gecko
0
0
Fork 0
mirror of https://gitlab.winehq.org/wine/wine-gecko.git synced 2024-09-13 09:24:08 -07:00
Code Issues Packages Projects Releases Wiki Activity
f1c0c07862
gecko/netwerk/protocol/wyciwyg/nsWyciwygChannel.cpp

800 lines
20 KiB
C++
Raw Blame History

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* This Source Code Form is subject to the terms of the Mozilla Public
* 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/. */
#include "nsWyciwyg.h"
#include "nsWyciwygChannel.h"
#include "nsILoadGroup.h"
#include "nsNetUtil.h"
#include "nsICacheService.h"
#include "nsICacheSession.h"
#include "nsCharsetSource.h"
#include "nsProxyRelease.h"
#include "nsThreadUtils.h"
#include "nsICacheEntryDescriptor.h"
#include "nsIEventTarget.h"
#include "nsIInputStream.h"
#include "nsIInputStreamPump.h"
#include "nsIOutputStream.h"
#include "nsIProgressEventSink.h"
#include "nsIURI.h"
#include "nsWyciwygProtocolHandler.h"
// Must release mChannel on the main thread
class nsWyciwygAsyncEvent : public nsRunnable {
public:
nsWyciwygAsyncEvent(nsWyciwygChannel *aChannel) : mChannel(aChannel) {}
~nsWyciwygAsyncEvent()
{
nsCOMPtr<nsIThread> thread = do_GetMainThread();
NS_WARN_IF_FALSE(thread, "Couldn't get the main thread!");
if (thread) {
nsIWyciwygChannel *chan = static_cast<nsIWyciwygChannel *>(mChannel);
mChannel.forget();
NS_ProxyRelease(thread, chan);
}
}
protected:
nsRefPtr<nsWyciwygChannel> mChannel;
};
class nsWyciwygSetCharsetandSourceEvent : public nsWyciwygAsyncEvent {
public:
nsWyciwygSetCharsetandSourceEvent(nsWyciwygChannel *aChannel)
: nsWyciwygAsyncEvent(aChannel) {}
NS_IMETHOD Run()
{
mChannel->SetCharsetAndSourceInternal();
return NS_OK;
}
};
class nsWyciwygWriteEvent : public nsWyciwygAsyncEvent {
public:
nsWyciwygWriteEvent(nsWyciwygChannel *aChannel, const nsAString &aData,
const nsACString &spec)
: nsWyciwygAsyncEvent(aChannel), mData(aData), mSpec(spec) {}
NS_IMETHOD Run()
{
mChannel->WriteToCacheEntryInternal(mData, mSpec);
return NS_OK;
}
private:
nsString mData;
nsCString mSpec;
};
class nsWyciwygCloseEvent : public nsWyciwygAsyncEvent {
public:
nsWyciwygCloseEvent(nsWyciwygChannel *aChannel, nsresult aReason)
: nsWyciwygAsyncEvent(aChannel), mReason(aReason) {}
NS_IMETHOD Run()
{
mChannel->CloseCacheEntryInternal(mReason);
return NS_OK;
}
private:
nsresult mReason;
};
// nsWyciwygChannel methods
nsWyciwygChannel::nsWyciwygChannel()
: mStatus(NS_OK),
mIsPending(false),
mCharsetAndSourceSet(false),
mNeedToWriteCharset(false),
mCharsetSource(kCharsetUninitialized),
mContentLength(-1),
mLoadFlags(LOAD_NORMAL),
mAppId(NECKO_NO_APP_ID),
mInBrowser(false)
{
}
nsWyciwygChannel::~nsWyciwygChannel()
{
}
NS_IMPL_ISUPPORTS7(nsWyciwygChannel,
nsIChannel,
nsIRequest,
nsIStreamListener,
nsIRequestObserver,
nsICacheListener,
nsIWyciwygChannel,
nsIPrivateBrowsingChannel)
nsresult
nsWyciwygChannel::Init(nsIURI* uri)
{
NS_ENSURE_ARG_POINTER(uri);
nsresult rv;
mURI = uri;
mOriginalURI = uri;
nsCOMPtr<nsICacheService> serv =
do_GetService(NS_CACHESERVICE_CONTRACTID, &rv);
NS_ENSURE_SUCCESS(rv, rv);
rv = serv->GetCacheIOTarget(getter_AddRefs(mCacheIOTarget));
NS_ENSURE_SUCCESS(rv, rv);
return NS_OK;
}
///////////////////////////////////////////////////////////////////////////////
// nsIRequest methods:
///////////////////////////////////////////////////////////////////////////////
NS_IMETHODIMP
nsWyciwygChannel::GetName(nsACString &aName)
{
return mURI->GetSpec(aName);
}
NS_IMETHODIMP
nsWyciwygChannel::IsPending(bool *aIsPending)
{
*aIsPending = mIsPending;
return NS_OK;
}
NS_IMETHODIMP
nsWyciwygChannel::GetStatus(nsresult *aStatus)
{
if (NS_SUCCEEDED(mStatus) && mPump)
mPump->GetStatus(aStatus);
else
*aStatus = mStatus;
return NS_OK;
}
NS_IMETHODIMP
nsWyciwygChannel::Cancel(nsresult status)
{
mStatus = status;
if (mPump)
mPump->Cancel(status);
// else we're waiting for OnCacheEntryAvailable
return NS_OK;
}
NS_IMETHODIMP
nsWyciwygChannel::Suspend()
{
if (mPump)
mPump->Suspend();
// XXX else, we'll ignore this ... and that's probably bad!
return NS_OK;
}
NS_IMETHODIMP
nsWyciwygChannel::Resume()
{
if (mPump)
mPump->Resume();
// XXX else, we'll ignore this ... and that's probably bad!
return NS_OK;
}
NS_IMETHODIMP
nsWyciwygChannel::GetLoadGroup(nsILoadGroup* *aLoadGroup)
{
*aLoadGroup = mLoadGroup;
NS_IF_ADDREF(*aLoadGroup);
return NS_OK;
}
NS_IMETHODIMP
nsWyciwygChannel::SetLoadGroup(nsILoadGroup* aLoadGroup)
{
if (!CanSetLoadGroup(aLoadGroup)) {
return NS_ERROR_FAILURE;
}
mLoadGroup = aLoadGroup;
NS_QueryNotificationCallbacks(mCallbacks,
mLoadGroup,
NS_GET_IID(nsIProgressEventSink),
getter_AddRefs(mProgressSink));
mPrivateBrowsing = NS_UsePrivateBrowsing(this);
NS_GetAppInfo(this, &mAppId, &mInBrowser);
return NS_OK;
}
NS_IMETHODIMP
nsWyciwygChannel::SetLoadFlags(uint32_t aLoadFlags)
{
mLoadFlags = aLoadFlags;
return NS_OK;
}
NS_IMETHODIMP
nsWyciwygChannel::GetLoadFlags(uint32_t * aLoadFlags)
{
*aLoadFlags = mLoadFlags;
return NS_OK;
}
////////////////////////////////////////////////////////////////////////////////
// nsIChannel methods:
///////////////////////////////////////////////////////////////////////////////
NS_IMETHODIMP
nsWyciwygChannel::GetOriginalURI(nsIURI* *aURI)
{
*aURI = mOriginalURI;
NS_ADDREF(*aURI);
return NS_OK;
}
NS_IMETHODIMP
nsWyciwygChannel::SetOriginalURI(nsIURI* aURI)
{
NS_ENSURE_ARG_POINTER(aURI);
mOriginalURI = aURI;
return NS_OK;
}
NS_IMETHODIMP
nsWyciwygChannel::GetURI(nsIURI* *aURI)
{
*aURI = mURI;
NS_IF_ADDREF(*aURI);
return NS_OK;
}
NS_IMETHODIMP
nsWyciwygChannel::GetOwner(nsISupports **aOwner)
{
NS_PRECONDITION(mOwner, "Must have a principal!");
NS_ENSURE_STATE(mOwner);
NS_ADDREF(*aOwner = mOwner);
return NS_OK;
}
NS_IMETHODIMP
nsWyciwygChannel::SetOwner(nsISupports* aOwner)
{
mOwner = aOwner;
return NS_OK;
}
NS_IMETHODIMP
nsWyciwygChannel::GetNotificationCallbacks(nsIInterfaceRequestor* *aCallbacks)
{
*aCallbacks = mCallbacks.get();
NS_IF_ADDREF(*aCallbacks);
return NS_OK;
}
NS_IMETHODIMP
nsWyciwygChannel::SetNotificationCallbacks(nsIInterfaceRequestor* aNotificationCallbacks)
{
if (!CanSetCallbacks(aNotificationCallbacks)) {
return NS_ERROR_FAILURE;
}
mCallbacks = aNotificationCallbacks;
NS_QueryNotificationCallbacks(mCallbacks,
mLoadGroup,
NS_GET_IID(nsIProgressEventSink),
getter_AddRefs(mProgressSink));
mPrivateBrowsing = NS_UsePrivateBrowsing(this);
NS_GetAppInfo(this, &mAppId, &mInBrowser);
return NS_OK;
}
NS_IMETHODIMP
nsWyciwygChannel::GetSecurityInfo(nsISupports * *aSecurityInfo)
{
NS_IF_ADDREF(*aSecurityInfo = mSecurityInfo);
return NS_OK;
}
NS_IMETHODIMP
nsWyciwygChannel::GetContentType(nsACString &aContentType)
{
aContentType.AssignLiteral(WYCIWYG_TYPE);
return NS_OK;
}
NS_IMETHODIMP
nsWyciwygChannel::SetContentType(const nsACString &aContentType)
{
return NS_ERROR_NOT_IMPLEMENTED;
}
NS_IMETHODIMP
nsWyciwygChannel::GetContentCharset(nsACString &aContentCharset)
{
aContentCharset.Assign("UTF-16");
return NS_OK;
}
NS_IMETHODIMP
nsWyciwygChannel::SetContentCharset(const nsACString &aContentCharset)
{
return NS_ERROR_NOT_IMPLEMENTED;
}
NS_IMETHODIMP
nsWyciwygChannel::GetContentDisposition(uint32_t *aContentDisposition)
{
return NS_ERROR_NOT_AVAILABLE;
}
NS_IMETHODIMP
nsWyciwygChannel::SetContentDisposition(uint32_t aContentDisposition)
{
return NS_ERROR_NOT_AVAILABLE;
}
NS_IMETHODIMP
nsWyciwygChannel::GetContentDispositionFilename(nsAString &aContentDispositionFilename)
{
return NS_ERROR_NOT_AVAILABLE;
}
NS_IMETHODIMP
nsWyciwygChannel::SetContentDispositionFilename(const nsAString &aContentDispositionFilename)
{
return NS_ERROR_NOT_AVAILABLE;
}
NS_IMETHODIMP
nsWyciwygChannel::GetContentDispositionHeader(nsACString &aContentDispositionHeader)
{
return NS_ERROR_NOT_AVAILABLE;
}
NS_IMETHODIMP
nsWyciwygChannel::GetContentLength(int64_t *aContentLength)
{
*aContentLength = mContentLength;
return NS_OK;
}
NS_IMETHODIMP
nsWyciwygChannel::SetContentLength(int64_t aContentLength)
{
mContentLength = aContentLength;
return NS_OK;
}
NS_IMETHODIMP
nsWyciwygChannel::Open(nsIInputStream ** aReturn)
{
return NS_ERROR_NOT_IMPLEMENTED;
}
NS_IMETHODIMP
nsWyciwygChannel::AsyncOpen(nsIStreamListener *listener, nsISupports *ctx)
{
LOG(("nsWyciwygChannel::AsyncOpen [this=%p]\n", this));
NS_ENSURE_TRUE(!mIsPending, NS_ERROR_IN_PROGRESS);
NS_ENSURE_ARG_POINTER(listener);
nsAutoCString spec;
mURI->GetSpec(spec);
// open a cache entry for this channel...
nsresult rv = OpenCacheEntry(spec, nsICache::ACCESS_READ);
if (rv == NS_ERROR_CACHE_KEY_NOT_FOUND) {
// Overwrite rv on purpose; if event dispatch fails we'll bail, and
// otherwise we'll wait until the event fires before calling back.
rv = NS_DispatchToCurrentThread(
NS_NewRunnableMethod(this, &nsWyciwygChannel::NotifyListener));
}
if (NS_FAILED(rv)) {
LOG(("nsWyciwygChannel::OpenCacheEntry failed [rv=%x]\n", rv));
return rv;
}
mIsPending = true;
mListener = listener;
mListenerContext = ctx;
if (mLoadGroup)
mLoadGroup->AddRequest(this, nullptr);
return NS_OK;
}
//////////////////////////////////////////////////////////////////////////////
// nsIWyciwygChannel
//////////////////////////////////////////////////////////////////////////////
NS_IMETHODIMP
nsWyciwygChannel::WriteToCacheEntry(const nsAString &aData)
{
// URIs not thread-safe, so get spec now in case we need it
nsAutoCString spec;
nsresult rv = mURI->GetAsciiSpec(spec);
if (NS_FAILED(rv))
return rv;
return mCacheIOTarget->Dispatch(new nsWyciwygWriteEvent(this, aData, spec),
NS_DISPATCH_NORMAL);
}
nsresult
nsWyciwygChannel::WriteToCacheEntryInternal(const nsAString &aData, const nsACString& spec)
{
NS_ASSERTION(IsOnCacheIOThread(), "wrong thread");
nsresult rv;
if (!mCacheEntry) {
rv = OpenCacheEntry(spec, nsICache::ACCESS_WRITE);
if (NS_FAILED(rv)) return rv;
}
if (mLoadFlags & INHIBIT_PERSISTENT_CACHING) {
rv = mCacheEntry->SetMetaDataElement("inhibit-persistent-caching", "1");
if (NS_FAILED(rv)) return rv;
}
if (mSecurityInfo) {
mCacheEntry->SetSecurityInfo(mSecurityInfo);
}
if (mNeedToWriteCharset) {
WriteCharsetAndSourceToCache(mCharsetSource, mCharset);
mNeedToWriteCharset = false;
}
uint32_t out;
if (!mCacheOutputStream) {
// Get the outputstream from the cache entry.
rv = mCacheEntry->OpenOutputStream(0, getter_AddRefs(mCacheOutputStream));
if (NS_FAILED(rv)) return rv;
// Write out a Byte Order Mark, so that we'll know if the data is
// BE or LE when we go to read it.
PRUnichar bom = 0xFEFF;
rv = mCacheOutputStream->Write((char *)&bom, sizeof(bom), &out);
if (NS_FAILED(rv)) return rv;
}
return mCacheOutputStream->Write((char *)PromiseFlatString(aData).get(),
aData.Length() * sizeof(PRUnichar), &out);
}
NS_IMETHODIMP
nsWyciwygChannel::CloseCacheEntry(nsresult reason)
{
return mCacheIOTarget->Dispatch(new nsWyciwygCloseEvent(this, reason),
NS_DISPATCH_NORMAL);
}
nsresult
nsWyciwygChannel::CloseCacheEntryInternal(nsresult reason)
{
NS_ASSERTION(IsOnCacheIOThread(), "wrong thread");
if (mCacheEntry) {
LOG(("nsWyciwygChannel::CloseCacheEntryInternal [this=%p ]", this));
mCacheOutputStream = 0;
mCacheInputStream = 0;
if (NS_FAILED(reason))
mCacheEntry->Doom();
mCacheEntry = 0;
}
return NS_OK;
}
NS_IMETHODIMP
nsWyciwygChannel::SetSecurityInfo(nsISupports *aSecurityInfo)
{
mSecurityInfo = aSecurityInfo;
return NS_OK;
}
NS_IMETHODIMP
nsWyciwygChannel::SetCharsetAndSource(int32_t aSource,
const nsACString& aCharset)
{
NS_ENSURE_ARG(!aCharset.IsEmpty());
mCharsetAndSourceSet = true;
mCharset = aCharset;
mCharsetSource = aSource;
return mCacheIOTarget->Dispatch(new nsWyciwygSetCharsetandSourceEvent(this),
NS_DISPATCH_NORMAL);
}
void
nsWyciwygChannel::SetCharsetAndSourceInternal()
{
NS_ASSERTION(IsOnCacheIOThread(), "wrong thread");
if (mCacheEntry) {
WriteCharsetAndSourceToCache(mCharsetSource, mCharset);
} else {
mNeedToWriteCharset = true;
}
}
NS_IMETHODIMP
nsWyciwygChannel::GetCharsetAndSource(int32_t* aSource, nsACString& aCharset)
{
if (mCharsetAndSourceSet) {
*aSource = mCharsetSource;
aCharset = mCharset;
return NS_OK;
}
if (!mCacheEntry) {
return NS_ERROR_NOT_AVAILABLE;
}
nsXPIDLCString data;
mCacheEntry->GetMetaDataElement("charset", getter_Copies(data));
if (data.IsEmpty()) {
return NS_ERROR_NOT_AVAILABLE;
}
nsXPIDLCString sourceStr;
mCacheEntry->GetMetaDataElement("charset-source", getter_Copies(sourceStr));
int32_t source;
nsresult err;
source = sourceStr.ToInteger(&err);
if (NS_FAILED(err) || source == 0) {
return NS_ERROR_NOT_AVAILABLE;
}
*aSource = source;
aCharset = data;
return NS_OK;
}
//////////////////////////////////////////////////////////////////////////////
// nsICachelistener
//////////////////////////////////////////////////////////////////////////////
NS_IMETHODIMP
nsWyciwygChannel::OnCacheEntryAvailable(nsICacheEntryDescriptor * aCacheEntry, nsCacheAccessMode aMode, nsresult aStatus)
{
LOG(("nsWyciwygChannel::OnCacheEntryAvailable [this=%p entry=%x "
"access=%x status=%x]\n", this, aCacheEntry, aMode, aStatus));
// if the channel's already fired onStopRequest,
// then we should ignore this event.
if (!mIsPending)
return NS_OK;
// otherwise, we have to handle this event.
if (NS_SUCCEEDED(aStatus))
mCacheEntry = aCacheEntry;
else if (NS_SUCCEEDED(mStatus))
mStatus = aStatus;
nsresult rv;
if (NS_FAILED(mStatus)) {
LOG(("channel was canceled [this=%p status=%x]\n", this, mStatus));
rv = mStatus;
}
else { // advance to the next state...
rv = ReadFromCache();
}
// a failure from Connect means that we have to abort the channel.
if (NS_FAILED(rv)) {
CloseCacheEntry(rv);
NotifyListener();
}
return NS_OK;
}
NS_IMETHODIMP
nsWyciwygChannel::OnCacheEntryDoomed(nsresult status)
{
return NS_ERROR_NOT_IMPLEMENTED;
}
//-----------------------------------------------------------------------------
// nsWyciwygChannel::nsIStreamListener
//-----------------------------------------------------------------------------
NS_IMETHODIMP
nsWyciwygChannel::OnDataAvailable(nsIRequest *request, nsISupports *ctx,
nsIInputStream *input,
uint64_t offset, uint32_t count)
{
LOG(("nsWyciwygChannel::OnDataAvailable [this=%p request=%x offset=%llu count=%u]\n",
this, request, offset, count));
nsresult rv;
rv = mListener->OnDataAvailable(this, mListenerContext, input, offset, count);
// XXX handle 64-bit stuff for real
if (mProgressSink && NS_SUCCEEDED(rv) && !(mLoadFlags & LOAD_BACKGROUND))
mProgressSink->OnProgress(this, nullptr, offset + count,
uint64_t(mContentLength));
return rv; // let the pump cancel on failure
}
//////////////////////////////////////////////////////////////////////////////
// nsIRequestObserver
//////////////////////////////////////////////////////////////////////////////
NS_IMETHODIMP
nsWyciwygChannel::OnStartRequest(nsIRequest *request, nsISupports *ctx)
{
LOG(("nsWyciwygChannel::OnStartRequest [this=%p request=%x\n",
this, request));
return mListener->OnStartRequest(this, mListenerContext);
}
NS_IMETHODIMP
nsWyciwygChannel::OnStopRequest(nsIRequest *request, nsISupports *ctx, nsresult status)
{
LOG(("nsWyciwygChannel::OnStopRequest [this=%p request=%x status=%d\n",
this, request, status));
if (NS_SUCCEEDED(mStatus))
mStatus = status;
mListener->OnStopRequest(this, mListenerContext, mStatus);
mListener = 0;
mListenerContext = 0;
if (mLoadGroup)
mLoadGroup->RemoveRequest(this, nullptr, mStatus);
CloseCacheEntry(mStatus);
mPump = 0;
mIsPending = false;
// Drop notification callbacks to prevent cycles.
mCallbacks = 0;
mProgressSink = 0;
return NS_OK;
}
//////////////////////////////////////////////////////////////////////////////
// Helper functions
//////////////////////////////////////////////////////////////////////////////
nsresult
nsWyciwygChannel::OpenCacheEntry(const nsACString & aCacheKey,
nsCacheAccessMode aAccessMode)
{
nsresult rv = NS_ERROR_FAILURE;
// Get cache service
nsCOMPtr<nsICacheService> cacheService =
do_GetService(NS_CACHESERVICE_CONTRACTID, &rv);
NS_ENSURE_SUCCESS(rv, rv);
// honor security settings
nsCacheStoragePolicy storagePolicy;
if (mPrivateBrowsing || mLoadFlags & INHIBIT_PERSISTENT_CACHING)
storagePolicy = nsICache::STORE_IN_MEMORY;
else
storagePolicy = nsICache::STORE_ANYWHERE;
nsCOMPtr<nsICacheSession> cacheSession;
nsAutoCString sessionName;
nsWyciwygProtocolHandler::GetCacheSessionName(mAppId, mInBrowser,
mPrivateBrowsing,
sessionName);
// Open a stream based cache session.
rv = cacheService->CreateSession(sessionName.get(), storagePolicy, true,
getter_AddRefs(cacheSession));
if (!cacheSession)
return NS_ERROR_FAILURE;
cacheSession->SetIsPrivate(mPrivateBrowsing);
if (aAccessMode == nsICache::ACCESS_WRITE)
rv = cacheSession->OpenCacheEntry(aCacheKey, aAccessMode, false,
getter_AddRefs(mCacheEntry));
else
rv = cacheSession->AsyncOpenCacheEntry(aCacheKey, aAccessMode, this, false);
return rv;
}
nsresult
nsWyciwygChannel::ReadFromCache()
{
LOG(("nsWyciwygChannel::ReadFromCache [this=%p] ", this));
NS_ENSURE_TRUE(mCacheEntry, NS_ERROR_FAILURE);
nsresult rv;
// Get the stored security info
mCacheEntry->GetSecurityInfo(getter_AddRefs(mSecurityInfo));
nsAutoCString tmpStr;
rv = mCacheEntry->GetMetaDataElement("inhibit-persistent-caching",
getter_Copies(tmpStr));
if (NS_SUCCEEDED(rv) && tmpStr == NS_LITERAL_CSTRING("1"))
mLoadFlags |= INHIBIT_PERSISTENT_CACHING;
// Get a transport to the cached data...
rv = mCacheEntry->OpenInputStream(0, getter_AddRefs(mCacheInputStream));
if (NS_FAILED(rv))
return rv;
NS_ENSURE_TRUE(mCacheInputStream, NS_ERROR_UNEXPECTED);
rv = NS_NewInputStreamPump(getter_AddRefs(mPump), mCacheInputStream);
if (NS_FAILED(rv)) return rv;
// Pump the cache data downstream
return mPump->AsyncRead(this, nullptr);
}
void
nsWyciwygChannel::WriteCharsetAndSourceToCache(int32_t aSource,
const nsCString& aCharset)
{
NS_ASSERTION(IsOnCacheIOThread(), "wrong thread");
NS_PRECONDITION(mCacheEntry, "Better have cache entry!");
mCacheEntry->SetMetaDataElement("charset", aCharset.get());
nsAutoCString source;
source.AppendInt(aSource);
mCacheEntry->SetMetaDataElement("charset-source", source.get());
}
void
nsWyciwygChannel::NotifyListener()
{
if (mListener) {
mListener->OnStartRequest(this, mListenerContext);
mListener->OnStopRequest(this, mListenerContext, mStatus);
mListener = 0;
mListenerContext = 0;
}
mIsPending = false;
// Remove ourselves from the load group.
if (mLoadGroup) {
mLoadGroup->RemoveRequest(this, nullptr, mStatus);
}
}
bool
nsWyciwygChannel::IsOnCacheIOThread()
{
bool correctThread;
mCacheIOTarget->IsOnCurrentThread(&correctThread);
return correctThread;
}
// vim: ts=2 sw=2
Reference in New Issue View Git Blame Copy Permalink