/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- * * The contents of this file are subject to the Netscape Public * License Version 1.1 (the "License"); you may not use this file * except in compliance with the License. You may obtain a copy of * the License at http://www.mozilla.org/NPL/ * * Software distributed under the License is distributed on an "AS * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or * implied. See the License for the specific language governing * rights and limitations under the License. * * The Original Code is Mozilla Communicator client code. * * The Initial Developer of the Original Code is Netscape Communications * Corporation. Portions created by Netscape are * Copyright (C) 1998 Netscape Communications Corporation. All * Rights Reserved. * * Contributor(s): */ #include "nsIDocumentLoader.h" #include "nsIWebShell.h" #include "prmem.h" #include "plstr.h" #include "nsString.h" #include "nsISupportsArray.h" #include "nsIURL.h" #include "nsIStreamListener.h" #include "nsIFactory.h" #include "nsIContentViewerContainer.h" #include "nsIContentViewer.h" #include "nsITimer.h" #include "nsIDocumentLoaderObserver.h" #include "nsVoidArray.h" #include "nsIServiceManager.h" #include "nsXPIDLString.h" #include "nsILoadGroup.h" //#include "nsILoadGroupObserver.h" #include "nsNeckoUtil.h" #include "nsIURL.h" #include "nsIDNSService.h" #include "nsIChannel.h" #include "nsIHTTPChannel.h" #include "nsHTTPEnums.h" #include "nsIProgressEventSink.h" #include "nsIGenericFactory.h" #include "nsIStreamLoadableDocument.h" #include "nsCOMPtr.h" #include "nsCom.h" #include "prlog.h" #include "prprf.h" #include "nsWeakReference.h" #include "nsIStreamConverterService.h" #include "nsIStreamConverter.h" static NS_DEFINE_CID(kStreamConverterServiceCID, NS_STREAMCONVERTERSERVICE_CID); #include #include "nsIPref.h" #include "nsIURIContentListener.h" #include "nsIURILoader.h" #include "nsCURILoader.h" // XXX ick ick ick #include "nsIDocument.h" #include "nsIPresShell.h" #include "nsIPresContext.h" #ifdef DEBUG #undef NOISY_CREATE_DOC #else #undef NOISY_CREATE_DOC #endif #if defined(DEBUG) || defined(FORCE_PR_LOG) PRLogModuleInfo* gDocLoaderLog = nsnull; #endif /* DEBUG || FORCE_PR_LOG */ /* Private IIDs... */ /* eb001fa0-214f-11d2-bec0-00805f8a66dc */ #define NS_DOCUMENTBINDINFO_IID \ { 0xeb001fa0, 0x214f, 0x11d2, \ {0xbe, 0xc0, 0x00, 0x80, 0x5f, 0x8a, 0x66, 0xdc} } /* Define IIDs... */ static NS_DEFINE_IID(kIStreamObserverIID, NS_ISTREAMOBSERVER_IID); static NS_DEFINE_IID(kIDocumentLoaderIID, NS_IDOCUMENTLOADER_IID); static NS_DEFINE_IID(kIDocumentLoaderFactoryIID, NS_IDOCUMENTLOADERFACTORY_IID); static NS_DEFINE_IID(kDocumentBindInfoIID, NS_DOCUMENTBINDINFO_IID); static NS_DEFINE_IID(kISupportsIID, NS_ISUPPORTS_IID); static NS_DEFINE_IID(kIDocumentIID, NS_IDOCUMENT_IID); static NS_DEFINE_IID(kIStreamListenerIID, NS_ISTREAMLISTENER_IID); static NS_DEFINE_IID(kIContentViewerContainerIID, NS_ICONTENT_VIEWER_CONTAINER_IID); static NS_DEFINE_CID(kGenericFactoryCID, NS_GENERICFACTORY_CID); /* Forward declarations.... */ class nsDocLoaderImpl; class nsChannelListener : public nsIStreamListener { public: nsChannelListener(); nsresult Init(nsDocLoaderImpl *aDocLoader, nsIStreamListener *aListener); NS_DECL_ISUPPORTS NS_DECL_NSISTREAMOBSERVER NS_DECL_NSISTREAMLISTENER protected: virtual ~nsChannelListener(); nsDocLoaderImpl *mDocLoader; nsCOMPtr mNextListener; }; /* * The nsDocumentBindInfo contains the state required when a single document * is being loaded... Each instance remains alive until its target URL has * been loaded (or aborted). * * The Document Loader maintains a list of nsDocumentBindInfo instances which * represents the set of documents actively being loaded... */ class nsDocumentBindInfo : public nsIStreamListener { public: nsDocumentBindInfo(); nsresult Init(nsDocLoaderImpl* aDocLoader, const char *aCommand, nsISupports* aContainer, nsISupports* aExtraInfo); NS_DECL_ISUPPORTS nsresult Bind(nsIURI *aURL, nsILoadGroup* aLoadGroup, nsIInputStream *postDataStream, const PRUnichar* aReferrer=nsnull); nsresult BindWithChannel(nsIChannel *aChannel); // nsIStreamObserver methods: NS_DECL_NSISTREAMOBSERVER // nsIStreamListener methods: NS_DECL_NSISTREAMLISTENER protected: virtual ~nsDocumentBindInfo(); protected: char* m_Command; nsCOMPtr m_Container; nsCOMPtr m_ExtraInfo; nsCOMPtr m_NextStream; nsDocLoaderImpl* m_DocLoader; }; /**************************************************************************** * nsDocLoaderImpl implementation... ****************************************************************************/ class nsDocLoaderImpl : public nsIDocumentLoader, public nsIStreamObserver, public nsILoadGroupListenerFactory, public nsSupportsWeakReference { public: nsDocLoaderImpl(); nsresult Init(); // for nsIGenericFactory: static NS_IMETHODIMP Create(nsISupports *aOuter, const nsIID &aIID, void **aResult); NS_DECL_ISUPPORTS NS_IMETHOD LoadOpenedDocument(nsIChannel * aOpenedChannel, const char * aCommand, nsIContentViewerContainer *aContainer, nsIInputStream * aPostDataStream, nsIURI * aReffererUrl, nsIStreamListener ** aContentHandler); // nsIDocumentLoader interface NS_IMETHOD LoadDocument(nsIURI * aUri, const char *aCommand, nsISupports* aContainer, nsIInputStream* aPostDataStream = nsnull, nsISupports* aExtraInfo = nsnull, nsLoadFlags aType = nsIChannel::LOAD_NORMAL, const PRUint32 aLocalIP = 0, const PRUnichar* aReferrer = nsnull); NS_IMETHOD LoadSubDocument(nsIURI * aUri, nsISupports* aExtraInfo = nsnull, nsLoadFlags aType = nsIChannel::LOAD_NORMAL, const PRUint32 aLocalIP = 0); NS_IMETHOD Stop(void); NS_IMETHOD IsBusy(PRBool& aResult); NS_IMETHOD CreateDocumentLoader(nsIDocumentLoader** anInstance); NS_IMETHOD AddObserver(nsIDocumentLoaderObserver *aObserver); NS_IMETHOD RemoveObserver(nsIDocumentLoaderObserver *aObserver); NS_IMETHOD SetContainer(nsISupports* aContainer); NS_IMETHOD GetContainer(nsISupports** aResult); NS_IMETHOD GetContentViewerContainer(PRUint32 aDocumentID, nsIContentViewerContainer** aResult); NS_IMETHOD GetLoadGroup(nsILoadGroup** aResult); NS_IMETHOD Destroy(); // nsILoadGroupListenerFactory methods... NS_IMETHOD CreateLoadGroupListener(nsIStreamListener *aListener, nsIStreamListener **aResult); // nsIStreamObserver methods: (for observing the load group) NS_DECL_NSISTREAMOBSERVER // Implementation specific methods... nsresult AddChildGroup(nsDocLoaderImpl *aLoader); nsresult RemoveChildGroup(nsDocLoaderImpl *aLoader); void FireOnStartDocumentLoad(nsDocLoaderImpl* aLoadInitiator, nsIURI* aURL, const char* aCommand); void FireOnEndDocumentLoad(nsDocLoaderImpl* aLoadInitiator, nsIChannel *aDocChannel, nsresult aStatus); void FireOnStartURLLoad(nsDocLoaderImpl* aLoadInitiator, nsIChannel* channel, nsIContentViewer* aViewer); void FireOnEndURLLoad(nsDocLoaderImpl* aLoadInitiator, nsIChannel* channel, nsresult aStatus); void SetParent(nsDocLoaderImpl* aParent); void SetDocumentChannel(nsIChannel* channel); nsILoadGroup* GetLoadGroup() { return mLoadGroup; } PRBool IsLoadingDocument() { return mIsLoadingDocument; } nsresult CreateContentViewer(const char *aCommand, nsIChannel* channel, const char* aContentType, nsISupports* aContainer, nsISupports* aExtraInfo, nsIStreamListener** aDocListener, nsIContentViewer** aDocViewer); protected: virtual ~nsDocLoaderImpl(); protected: static PRBool IsBusyEnumerator(nsISupports* aElement, void* aData); // IMPORTANT: The ownership implicit in the following member // variables has been explicitly checked and set using nsCOMPtr // for owning pointers and raw COM interface pointers for weak // (ie, non owning) references. If you add any members to this // class, please make the ownership explicit (pinkerton, scc). nsCOMPtr mDocumentChannel; // [OWNER] ???compare with document nsVoidArray mDocObservers; nsISupports* mContainer; // [WEAK] it owns me! nsDocLoaderImpl* mParent; // [OWNER] but upside down ownership model // needs to be fixed*** /* * This flag indicates that the loader is loading a document. It is set * from the call to LoadDocument(...) until the OnConnectionsComplete(...) * notification is fired... */ PRBool mIsLoadingDocument; nsCOMPtr mLoadGroup; nsCOMPtr mChildList; }; nsDocLoaderImpl::nsDocLoaderImpl() { NS_INIT_REFCNT(); #if defined(DEBUG) || defined(FORCE_PR_LOG) if (nsnull == gDocLoaderLog) { gDocLoaderLog = PR_NewLogModule("DocLoader"); } #endif /* DEBUG || FORCE_PR_LOG */ mContainer = nsnull; mParent = nsnull; mIsLoadingDocument = PR_FALSE; PR_LOG(gDocLoaderLog, PR_LOG_DEBUG, ("DocLoader:%p: created.\n", this)); } nsresult nsDocLoaderImpl::Init() { nsresult rv; rv = NS_NewLoadGroup(nsnull, this, nsnull, getter_AddRefs(mLoadGroup)); if (NS_FAILED(rv)) return rv; PR_LOG(gDocLoaderLog, PR_LOG_DEBUG, ("DocLoader:%p: load group %x.\n", this, mLoadGroup.get())); rv = mLoadGroup->SetGroupListenerFactory(this); if (NS_FAILED(rv)) return rv; rv = NS_NewISupportsArray(getter_AddRefs(mChildList)); return rv; } nsDocLoaderImpl::~nsDocLoaderImpl() { /* |ClearWeakReferences()| here is intended to prevent people holding weak references from re-entering this destructor since |QueryReferent()| will |AddRef()| me, and the subsequent |Release()| will try to destroy me. At this point there should be only weak references remaining (otherwise, we wouldn't be getting destroyed). An alternative would be incrementing our refcount (consider it a compressed flag saying "Don't re-destroy."). I haven't yet decided which is better. [scc] */ ClearWeakReferences(); Destroy(); PR_LOG(gDocLoaderLog, PR_LOG_DEBUG, ("DocLoader:%p: deleted.\n", this)); #ifdef DEBUG PRUint32 count=0; mChildList->Count(&count); NS_PRECONDITION((0 == count), "Document loader has children..."); #endif } /* * Implementation of ISupports methods... */ NS_IMPL_ADDREF(nsDocLoaderImpl); NS_IMPL_RELEASE(nsDocLoaderImpl); NS_IMETHODIMP nsDocLoaderImpl::QueryInterface(REFNSIID aIID, void** aInstancePtr) { if (NULL == aInstancePtr) { return NS_ERROR_NULL_POINTER; } if (aIID.Equals(kIDocumentLoaderIID)) { *aInstancePtr = (void*)(nsIDocumentLoader*)this; NS_ADDREF_THIS(); return NS_OK; } if (aIID.Equals(nsCOMTypeInfo::GetIID())) { *aInstancePtr = (void*)(nsILoadGroupListenerFactory*)this; NS_ADDREF_THIS(); return NS_OK; } if (aIID.Equals(kIStreamObserverIID)) { *aInstancePtr = (void*)(nsIStreamObserver*)this; NS_ADDREF_THIS(); return NS_OK; } if (aIID.Equals(nsCOMTypeInfo::GetIID())) { *aInstancePtr = NS_STATIC_CAST(nsISupportsWeakReference*,this); NS_ADDREF_THIS(); return NS_OK; } return NS_NOINTERFACE; } NS_IMETHODIMP nsDocLoaderImpl::CreateDocumentLoader(nsIDocumentLoader** anInstance) { nsDocLoaderImpl* newLoader = nsnull; nsresult rv = NS_OK; /* Check for initial error conditions... */ if (nsnull == anInstance) { rv = NS_ERROR_NULL_POINTER; goto done; } NS_NEWXPCOM(newLoader, nsDocLoaderImpl); if (nsnull == newLoader) { *anInstance = nsnull; rv = NS_ERROR_OUT_OF_MEMORY; goto done; } rv = newLoader->QueryInterface(kIDocumentLoaderIID, (void**)anInstance); if (NS_SUCCEEDED(rv)) { // Initialize now that we have a reference rv = newLoader->Init(); if (NS_SUCCEEDED(rv)) { AddChildGroup(newLoader); newLoader->SetParent(this); } } done: return rv; } nsresult nsDocLoaderImpl::CreateContentViewer(const char *aCommand, nsIChannel* channel, const char* aContentType, nsISupports* aContainer, nsISupports* aExtraInfo, nsIStreamListener** aDocListenerResult, nsIContentViewer** aDocViewerResult) { // Lookup class-id for the command plus content-type combination nsCID cid; char id[500]; PR_snprintf(id, sizeof(id), NS_DOCUMENT_LOADER_FACTORY_PROGID_PREFIX "%s/%s", aCommand ? aCommand : "view",/* XXX bug! shouldn't b needed!*/ aContentType); nsresult rv = nsComponentManager::ProgIDToCLSID(id, &cid); if (NS_FAILED(rv)) { return rv; } // Create an instance of the document-loader-factory object nsIDocumentLoaderFactory* factory; rv = nsComponentManager::CreateInstance(cid, (nsISupports *)nsnull, kIDocumentLoaderFactoryIID, (void **)&factory); if (NS_FAILED(rv)) { return rv; } // Now create an instance of the content viewer rv = factory->CreateInstance(aCommand, channel, mLoadGroup, aContentType, aContainer, aExtraInfo, aDocListenerResult, aDocViewerResult); NS_RELEASE(factory); return rv; } NS_IMETHODIMP nsDocLoaderImpl::LoadOpenedDocument(nsIChannel * aOpenedChannel, const char * aCommand, nsIContentViewerContainer *aContainer, nsIInputStream * aPostDataStream, nsIURI * aReffererUrl, nsIStreamListener ** aContentHandler) { // mscott - there's a big flaw here...we'll proably need to reset the // loadgroupon the channel to theloadgroup associated with the content // viewer container since that's the new guy whose actually going to be // receiving the content nsresult rv = NS_OK; nsDocumentBindInfo* loader = nsnull; if (!aOpenedChannel) return NS_ERROR_NULL_POINTER; NS_NEWXPCOM(loader, nsDocumentBindInfo); if (nsnull == loader) return NS_ERROR_OUT_OF_MEMORY; NS_ADDREF(loader); loader->Init(this, // DocLoader aCommand, // Command aContainer, // Viewer Container /* aExtraInfo */ nsnull); // Extra Info rv = loader->BindWithChannel(aOpenedChannel); loader->QueryInterface(NS_GET_IID(nsIStreamListener), (void **) aContentHandler); /* * Set the flag indicating that the document loader is in the process of * loading a document. This flag will remain set until the * OnConnectionsComplete(...) notification is fired for the loader... */ mIsLoadingDocument = PR_TRUE; return rv; } static NS_DEFINE_CID(kURILoaderCID, NS_URI_LOADER_CID); static NS_DEFINE_CID(kPrefServiceCID, NS_PREF_CID); // start up prefs NS_IMETHODIMP nsDocLoaderImpl::LoadDocument(nsIURI * aUri, const char* aCommand, nsISupports* aContainer, nsIInputStream* aPostDataStream, nsISupports* aExtraInfo, nsLoadFlags aType, const PRUint32 aLocalIP, const PRUnichar* aReferrer) { nsresult rv = NS_OK; NS_WITH_SERVICE(nsIPref, prefs, kPrefServiceCID, &rv); PRBool useURILoader = PR_FALSE; if (NS_SUCCEEDED(rv)) prefs->GetBoolPref("browser.uriloader", &useURILoader); nsXPIDLCString aUrlSpec; // right now, uri dispatching is only hooked up to work with imap, mailbox and // news urls...so as a hack....check the protocol scheme and only call the // dispatching code for those schemes which work with uri dispatching... if (useURILoader && aUri) { aUri->GetScheme(getter_Copies(aUrlSpec)); if (nsCRT::strcasecmp(aUrlSpec, "imap") == 0 || nsCRT::strcasecmp(aUrlSpec, "news") == 0 || nsCRT::strcasecmp(aUrlSpec, "mailbox") == 0 || nsCRT::strcasecmp(aUrlSpec, "mailboxMessage") ==0 || nsCRT::strcasecmp(aUrlSpec, "mailto") == 0 || nsCRT::strcasecmp(aUrlSpec, "http") == 0) { nsCOMPtr progressSink = do_QueryInterface(aContainer); nsCOMPtr contentListener = do_QueryInterface(aContainer); nsCOMPtr aOpenContext = do_QueryInterface(mLoadGroup); // let's try uri dispatching... NS_WITH_SERVICE(nsIURILoader, pURILoader, kURILoaderCID, &rv); if (NS_SUCCEEDED(rv)) { rv = pURILoader->OpenURI(aUri, nsnull /* window target */, progressSink, contentListener, nsnull /* refferring URI */, mLoadGroup, getter_AddRefs(aOpenContext)); if (aOpenContext) mLoadGroup = do_QueryInterface(aOpenContext); } return rv; } } // end try uri loader code nsDocumentBindInfo* loader = nsnull; if (!aUri) return NS_ERROR_NULL_POINTER; #if defined(DEBUG) nsXPIDLCString urlSpec; aUri->GetSpec(getter_Copies(urlSpec)); PR_LOG(gDocLoaderLog, PR_LOG_DEBUG, ("DocLoader:%p: LoadDocument(...) called for %s.", this, (const char *) urlSpec)); #endif /* DEBUG */ /* Check for initial error conditions... */ if (nsnull == aContainer) { rv = NS_ERROR_NULL_POINTER; goto done; } NS_NEWXPCOM(loader, nsDocumentBindInfo); if (nsnull == loader) { rv = NS_ERROR_OUT_OF_MEMORY; goto done; } NS_ADDREF(loader); loader->Init(this, // DocLoader aCommand, // Command aContainer, // Viewer Container aExtraInfo); // Extra Info /* * Set the flag indicating that the document loader is in the process of * loading a document. This flag will remain set until the * OnConnectionsComplete(...) notification is fired for the loader... */ mIsLoadingDocument = PR_TRUE; rv = loader->Bind(aUri, mLoadGroup, aPostDataStream, aReferrer); done: NS_RELEASE(loader); return rv; } NS_IMETHODIMP nsDocLoaderImpl::LoadSubDocument(nsIURI *aUri, nsISupports* aExtraInfo, nsLoadFlags aType, const PRUint32 aLocalIP) { nsresult rv; nsDocumentBindInfo* loader = nsnull; if (!aUri) return NS_ERROR_NULL_POINTER; #ifdef DEBUG nsXPIDLCString uriSpec; rv = aUri->GetSpec(getter_Copies(uriSpec)); if (NS_FAILED(rv)) return rv; PR_LOG(gDocLoaderLog, PR_LOG_DEBUG, ("DocLoader:%p: LoadSubDocument(...) called for %s.", this, (const char *) uriSpec)); #endif /* DEBUG */ NS_NEWXPCOM(loader, nsDocumentBindInfo); if (nsnull == loader) { rv = NS_ERROR_OUT_OF_MEMORY; return rv; } NS_ADDREF(loader); loader->Init(this, // DocLoader nsnull, // Command nsnull, // Viewer Container aExtraInfo); // Extra Info rv = loader->Bind(aUri, mLoadGroup, nsnull, nsnull); NS_RELEASE(loader); return rv; } NS_IMETHODIMP nsDocLoaderImpl::Stop(void) { nsresult rv = NS_OK; PR_LOG(gDocLoaderLog, PR_LOG_DEBUG, ("DocLoader:%p: Stop() called\n", this)); rv = mLoadGroup->Cancel(); return rv; } NS_IMETHODIMP nsDocLoaderImpl::IsBusy(PRBool& aResult) { aResult = PR_FALSE; /* If this document loader is busy? */ if (mIsLoadingDocument) { aResult = PR_TRUE; } /* Otherwise, check its child document loaders... */ else { mChildList->EnumerateForwards(nsDocLoaderImpl::IsBusyEnumerator, (void*)&aResult); } return NS_OK; } /* * Do not hold refs to the objects in the observer lists. Observers * are expected to remove themselves upon their destruction if they * have not removed themselves previously */ NS_IMETHODIMP nsDocLoaderImpl::AddObserver(nsIDocumentLoaderObserver* aObserver) { // Make sure the observer isn't already in the list if (mDocObservers.IndexOf(aObserver) == -1) { mDocObservers.AppendElement(aObserver); } return NS_OK; } NS_IMETHODIMP nsDocLoaderImpl::RemoveObserver(nsIDocumentLoaderObserver* aObserver) { if (PR_TRUE == mDocObservers.RemoveElement(aObserver)) { return NS_OK; } return NS_ERROR_FAILURE; } NS_IMETHODIMP nsDocLoaderImpl::SetContainer(nsISupports* aContainer) { // This is a weak reference... mContainer = aContainer; return NS_OK; } NS_IMETHODIMP nsDocLoaderImpl::GetContainer(nsISupports** aResult) { NS_ENSURE_ARG_POINTER(aResult); *aResult = mContainer; NS_IF_ADDREF(*aResult); return NS_OK; } NS_IMETHODIMP nsDocLoaderImpl::GetLoadGroup(nsILoadGroup** aResult) { nsresult rv = NS_OK; if (nsnull == aResult) { rv = NS_ERROR_NULL_POINTER; } else { *aResult = mLoadGroup; NS_IF_ADDREF(*aResult); } return rv; } NS_IMETHODIMP nsDocLoaderImpl::GetContentViewerContainer(PRUint32 aDocumentID, nsIContentViewerContainer** aResult) { nsISupports* base = (nsISupports*) aDocumentID; nsIDocument* doc; nsresult rv; rv = base->QueryInterface(kIDocumentIID, (void**)&doc); if (NS_SUCCEEDED(rv)) { nsIPresShell* pres; pres = doc->GetShellAt(0); if (nsnull != pres) { nsIPresContext* presContext; rv = pres->GetPresContext(&presContext); if (NS_SUCCEEDED(rv) && nsnull != presContext) { nsISupports* supp; rv = presContext->GetContainer(&supp); if (NS_SUCCEEDED(rv) && nsnull != supp) { rv = supp->QueryInterface(kIContentViewerContainerIID, (void**)aResult); NS_RELEASE(supp); } NS_RELEASE(presContext); } NS_RELEASE(pres); } NS_RELEASE(doc); } return rv; } NS_IMETHODIMP nsDocLoaderImpl::Destroy() { Stop(); // Remove the document loader from the parent list of loaders... if (mParent) { mParent->RemoveChildGroup(this); NS_RELEASE(mParent); } mDocumentChannel = null_nsCOMPtr(); // Clear factory pointer (which is the docloader) (void)mLoadGroup->SetGroupListenerFactory(nsnull); mLoadGroup->SetGroupObserver(nsnull); return NS_OK; } NS_IMETHODIMP nsDocLoaderImpl::OnStartRequest(nsIChannel *channel, nsISupports *ctxt) { // called when the group gets its first element nsresult rv; nsCOMPtr uri; rv = channel->GetURI(getter_AddRefs(uri)); if (NS_FAILED(rv)) return rv; // // Only fire an OnStartDocumentLoad(...) if the document loader // has initiated a load... Otherwise, this notification has // resulted from a channel being added to the load group. // if (mIsLoadingDocument) { FireOnStartDocumentLoad(this, uri, "load"); // XXX fix command } return NS_OK; } NS_IMETHODIMP nsDocLoaderImpl::OnStopRequest(nsIChannel *channel, nsISupports *ctxt, nsresult status, const PRUnichar *errorMsg) { PR_LOG(gDocLoaderLog, PR_LOG_DEBUG, ("DocLoader:%p: Is now idle...\n", this)); // // Only fire the OnEndDocumentLoad(...) if the document loader // has initiated a load... // if (mIsLoadingDocument) { nsCOMPtr docChannel(mDocumentChannel); mDocumentChannel = null_nsCOMPtr(); mIsLoadingDocument = PR_FALSE; // // Do nothing after firing the OnEndDocumentLoad(...). The document // loader may be loading a *new* document - if LoadDocument() // was called from a handler! // FireOnEndDocumentLoad(this, docChannel, status); } return NS_OK; } nsresult nsDocLoaderImpl::AddChildGroup(nsDocLoaderImpl* aLoader) { nsresult rv; rv = mLoadGroup->AddSubGroup(aLoader->GetLoadGroup()); if (NS_SUCCEEDED(rv)) { mChildList->AppendElement((nsIDocumentLoader*)aLoader); } return rv; } nsresult nsDocLoaderImpl::RemoveChildGroup(nsDocLoaderImpl* aLoader) { nsresult rv; rv = mLoadGroup->RemoveSubGroup(aLoader->GetLoadGroup()); if (NS_SUCCEEDED(rv)) { mChildList->RemoveElement((nsIDocumentLoader*)aLoader); } return rv; } NS_IMETHODIMP nsDocLoaderImpl::CreateLoadGroupListener(nsIStreamListener *aListener, nsIStreamListener **aResult) { nsChannelListener *newListener; NS_NEWXPCOM(newListener, nsChannelListener); if (nsnull == newListener) { return NS_ERROR_OUT_OF_MEMORY; } NS_ADDREF(newListener); newListener->Init(this, aListener); *aResult = newListener; return NS_OK; } void nsDocLoaderImpl::FireOnStartDocumentLoad(nsDocLoaderImpl* aLoadInitiator, nsIURI* aURL, const char* aCommand) { PRInt32 count = mDocObservers.Count(); PRInt32 index; #if defined(DEBUG) char *buffer; aURL->GetSpec(&buffer); PR_LOG(gDocLoaderLog, PR_LOG_DEBUG, ("DocLoader:%p: Firing OnStartDocumentLoad(...) called for [DocLoader:%p] %s.\n", this, aLoadInitiator, buffer)); nsCRT::free(buffer); #endif /* DEBUG */ /* * First notify any observers that the URL load has begun... */ for (index = 0; index < count; index++) { nsIDocumentLoaderObserver* observer = (nsIDocumentLoaderObserver*)mDocObservers.ElementAt(index); observer->OnStartDocumentLoad(aLoadInitiator, aURL, aCommand); } /* * Finally notify the parent... */ if (mParent) { mParent->FireOnStartDocumentLoad(aLoadInitiator, aURL, aCommand); } } void nsDocLoaderImpl::FireOnEndDocumentLoad(nsDocLoaderImpl* aLoadInitiator, nsIChannel *aDocChannel, nsresult aStatus) { #if defined(DEBUG) nsCOMPtr uri; nsresult rv = NS_OK; if (aDocChannel) rv = aDocChannel->GetURI(getter_AddRefs(uri)); if (NS_SUCCEEDED(rv)) { char* buffer = nsnull; if (uri) rv = uri->GetSpec(&buffer); if (NS_SUCCEEDED(rv) && buffer != nsnull) { PR_LOG(gDocLoaderLog, PR_LOG_DEBUG, ("DocLoader:%p: Firing OnEndDocumentLoad(...) called for [DocLoader:%p] %s\n", this, aLoadInitiator, buffer)); nsCRT::free(buffer); } } #endif /* DEBUG */ /* * First notify any observers that the document load has finished... */ PRInt32 count = mDocObservers.Count(); PRInt32 index; for (index = 0; index < count; index++) { nsIDocumentLoaderObserver* observer = (nsIDocumentLoaderObserver*) mDocObservers.ElementAt(index); if (observer) { observer->OnEndDocumentLoad(aLoadInitiator, aDocChannel, aStatus, observer); } } /* * Next notify the parent... */ if (mParent) { mParent->FireOnEndDocumentLoad(aLoadInitiator, aDocChannel, aStatus); } } void nsDocLoaderImpl::FireOnStartURLLoad(nsDocLoaderImpl* aLoadInitiator, nsIChannel* channel, nsIContentViewer* aViewer) { PRInt32 count = mDocObservers.Count(); PRInt32 index; /* * First notify any observers that the URL load has begun... */ for (index = 0; index < count; index++) { nsIDocumentLoaderObserver* observer = (nsIDocumentLoaderObserver*)mDocObservers.ElementAt(index); observer->OnStartURLLoad(aLoadInitiator, channel, aViewer); } /* * Finally notify the parent... */ if (mParent) { mParent->FireOnStartURLLoad(aLoadInitiator, channel, aViewer); } } void nsDocLoaderImpl::FireOnEndURLLoad(nsDocLoaderImpl* aLoadInitiator, nsIChannel* channel, nsresult aStatus) { PRInt32 count = mDocObservers.Count(); PRInt32 index; /* * First notify any observers that the URL load has begun... */ for (index = 0; index < count; index++) { nsIDocumentLoaderObserver* observer = (nsIDocumentLoaderObserver*)mDocObservers.ElementAt(index); observer->OnEndURLLoad(aLoadInitiator, channel, aStatus); } /* * Finally notify the parent... */ if (mParent) { mParent->FireOnEndURLLoad(aLoadInitiator, channel, aStatus); } } void nsDocLoaderImpl::SetParent(nsDocLoaderImpl* aParent) { NS_IF_RELEASE(mParent); mParent = aParent; NS_IF_ADDREF(mParent); } void nsDocLoaderImpl::SetDocumentChannel(nsIChannel* channel) { mDocumentChannel = channel; } PRBool nsDocLoaderImpl::IsBusyEnumerator(nsISupports* aElement, void* aData) { nsCOMPtr docLoader; PRBool* result = (PRBool*)aData; docLoader = do_QueryInterface(aElement); if (docLoader) { docLoader->IsBusy(*result); } return !(*result); } /**************************************************************************** * nsDocumentBindInfo implementation... ****************************************************************************/ nsDocumentBindInfo::nsDocumentBindInfo() { NS_INIT_REFCNT(); m_Command = nsnull; m_DocLoader = nsnull; } nsresult nsDocumentBindInfo::Init(nsDocLoaderImpl* aDocLoader, const char *aCommand, nsISupports* aContainer, nsISupports* aExtraInfo) { m_Command = (nsnull != aCommand) ? PL_strdup(aCommand) : nsnull; m_DocLoader = aDocLoader; NS_ADDREF(m_DocLoader); m_Container = aContainer; // This does an addref m_ExtraInfo = aExtraInfo; // This does an addref return NS_OK; } nsDocumentBindInfo::~nsDocumentBindInfo() { if (m_Command) { PR_Free(m_Command); } m_Command = nsnull; NS_RELEASE (m_DocLoader); } /* * Implementation of ISupports methods... */ NS_IMPL_ADDREF(nsDocumentBindInfo); NS_IMPL_RELEASE(nsDocumentBindInfo); nsresult nsDocumentBindInfo::QueryInterface(const nsIID& aIID, void** aInstancePtrResult) { NS_PRECONDITION(nsnull != aInstancePtrResult, "null pointer"); if (nsnull == aInstancePtrResult) { return NS_ERROR_NULL_POINTER; } *aInstancePtrResult = NULL; if (aIID.Equals(kIStreamObserverIID)) { *aInstancePtrResult = (void*) ((nsIStreamObserver*)this); NS_ADDREF_THIS(); return NS_OK; } if (aIID.Equals(kIStreamListenerIID)) { *aInstancePtrResult = (void*) ((nsIStreamListener*)this); NS_ADDREF_THIS(); return NS_OK; } if (aIID.Equals(kDocumentBindInfoIID)) { *aInstancePtrResult = (void*) this; NS_ADDREF_THIS(); return NS_OK; } if (aIID.Equals(kISupportsIID)) { *aInstancePtrResult = (void*) ((nsISupports*) this); NS_ADDREF_THIS(); return NS_OK; } return NS_NOINTERFACE; } nsresult nsDocumentBindInfo::BindWithChannel(nsIChannel *aChannel) { m_DocLoader->SetDocumentChannel(aChannel); return NS_OK; } nsresult nsDocumentBindInfo::Bind(nsIURI* aURL, nsILoadGroup *aLoadGroup, nsIInputStream *postDataStream, const PRUnichar* aReferrer) { nsresult rv = NS_OK; // XXXbe this knows that m_Container implements nsIWebShell nsCOMPtr capabilities = do_QueryInterface(m_Container); nsCOMPtr channel; rv = NS_OpenURI(getter_AddRefs(channel), aURL, aLoadGroup, capabilities); if (NS_FAILED(rv)) return rv; if (postDataStream || aReferrer) { nsCOMPtr httpChannel(do_QueryInterface(channel)); if (httpChannel) { if (postDataStream) { httpChannel->SetRequestMethod(HM_POST); httpChannel->SetPostDataStream(postDataStream); } if (aReferrer) { // Referer - misspelled, but per the HTTP spec nsCAutoString str = aReferrer; nsCOMPtr key = NS_NewAtom("referer"); httpChannel->SetRequestHeader(key, str.GetBuffer()); } } } m_DocLoader->SetDocumentChannel(channel); rv = channel->AsyncRead(0, -1, nsnull, this); return rv; } NS_IMETHODIMP nsDocumentBindInfo::OnStartRequest(nsIChannel* channel, nsISupports *ctxt) { nsresult rv = NS_OK; nsIContentViewer* viewer = nsnull; nsCOMPtr aURL; rv = channel->GetURI(getter_AddRefs(aURL)); if (NS_FAILED(rv)) return rv; char* aContentType = nsnull; rv = channel->GetContentType(&aContentType); if (NS_FAILED(rv)) return rv; #if defined(DEBUG) char* spec; (void)aURL->GetSpec(&spec); PR_LOG(gDocLoaderLog, PR_LOG_DEBUG, ("DocumentBindInfo:%p OnStartRequest(...) called for %s. Content-type is %s\n", this, spec, aContentType)); nsCRT::free(spec); #endif /* DEBUG */ if (nsnull == m_NextStream) { /* * Now that the content type is available, create a document * (and viewer) of the appropriate type... */ if (m_DocLoader) { rv = m_DocLoader->CreateContentViewer(m_Command, channel, aContentType, m_Container, m_ExtraInfo, getter_AddRefs(m_NextStream), &viewer); } else { rv = NS_ERROR_NULL_POINTER; } if (NS_FAILED(rv)) { printf("DocLoaderFactory: Unable to create ContentViewer for command=%s, content-type=%s\n", m_Command ? m_Command : "(null)", aContentType); nsCOMPtr cvContainer(do_QueryInterface(m_Container)); if ( cvContainer ) { // Give content container a chance to do something with this URL. rv = cvContainer->HandleUnknownContentType( (nsIDocumentLoader*) m_DocLoader, channel, aContentType, m_Command ); } // Stop the binding. // This crashes on Unix/Mac... Stop(); goto done; } /* * Give the document container the new viewer... */ nsCOMPtr cvContainer(do_QueryInterface(m_Container)); if (cvContainer) { viewer->SetContainer(m_Container); rv = cvContainer->Embed(viewer, m_Command, m_ExtraInfo); if (NS_FAILED(rv)) { goto done; } } } /* * Pass the OnStartRequest(...) notification out to the document * IStreamListener. */ if (nsnull != m_NextStream) { rv = m_NextStream->OnStartRequest(channel, ctxt); } done: NS_IF_RELEASE(viewer); nsCRT::free(aContentType); return rv; } NS_METHOD nsDocumentBindInfo::OnDataAvailable(nsIChannel* channel, nsISupports *ctxt, nsIInputStream *aStream, PRUint32 sourceOffset, PRUint32 aLength) { nsresult rv; nsCOMPtr aURL; rv = channel->GetURI(getter_AddRefs(aURL)); if (NS_FAILED(rv)) return rv; #if defined(DEBUG) char* spec; (void)aURL->GetSpec(&spec); PR_LOG(gDocLoaderLog, PR_LOG_DEBUG, ("DocumentBindInfo:%p: OnDataAvailable(...) called for %s. Bytes available: %d.\n", this, spec, aLength)); nsCRT::free(spec); #endif /* DEBUG */ if (nsnull != m_NextStream) { /* * Bump the refcount in case the stream gets destroyed while the data * is being processed... If Stop(...) is called the stream could be * freed prematurely :-( * * Currently this can happen if javascript loads a new URL * (via nsIWebShell::LoadURL) during the parse phase... */ nsCOMPtr listener(m_NextStream); rv = listener->OnDataAvailable(channel, ctxt, aStream, sourceOffset, aLength); } else { rv = NS_BINDING_FAILED; } return rv; } NS_METHOD nsDocumentBindInfo::OnStopRequest(nsIChannel* channel, nsISupports *ctxt, nsresult aStatus, const PRUnichar *aMsg) { nsresult rv; nsCOMPtr aURL; rv = channel->GetURI(getter_AddRefs(aURL)); if (NS_FAILED(rv)) return rv; #if defined(DEBUG) char* spec; (void)aURL->GetSpec(&spec); PR_LOG(gDocLoaderLog, PR_LOG_DEBUG, ("DocumentBindInfo:%p: OnStopRequest(...) called for %s. Status: %d.\n", this, spec, aStatus)); nsCRT::free(spec); #endif // DEBUG if (NS_FAILED(aStatus)) { char *url; aURL->GetSpec(&url); if (aStatus == NS_ERROR_UNKNOWN_HOST) printf("Error: Unknown host: %s\n", url); else if (aStatus == NS_ERROR_MALFORMED_URI) printf("Error: Malformed URI: %s\n", url); else if (NS_FAILED(aStatus)) printf("Error: Can't load: %s (%x)\n", url, aStatus); nsCRT::free(url); } if (nsnull != m_NextStream) { rv = m_NextStream->OnStopRequest(channel, ctxt, aStatus, aMsg); } m_NextStream = nsnull; // Release our stream we are holding return rv; } NS_IMPL_ISUPPORTS2(nsChannelListener, nsIStreamObserver, nsIStreamListener); nsChannelListener::nsChannelListener() { NS_INIT_REFCNT(); mDocLoader = nsnull; } nsresult nsChannelListener::Init(nsDocLoaderImpl *aDocLoader, nsIStreamListener *aListener) { mDocLoader = aDocLoader; NS_ADDREF(mDocLoader); mNextListener = aListener; return NS_OK; } nsChannelListener::~nsChannelListener() { NS_RELEASE(mDocLoader); mNextListener = null_nsCOMPtr(); } NS_IMETHODIMP nsChannelListener::OnStartRequest(nsIChannel *aChannel, nsISupports *aContext) { nsresult rv; nsCOMPtr viewer; /////////////////////////////// // STREAM CONVERTERS /////////////////////////////// // if we are using the uri loader, it handles the stream converter work for us! NS_WITH_SERVICE(nsIPref, prefs, kPrefServiceCID, &rv); PRBool useURILoader = PR_FALSE; if (NS_SUCCEEDED(rv)) prefs->GetBoolPref("browser.uriloader", &useURILoader); if (!useURILoader) { nsXPIDLCString contentType; rv = aChannel->GetContentType(getter_Copies(contentType)); if (NS_FAILED(rv)) return rv; PRBool conversionRequired = PR_FALSE; nsAutoString from, to; // Let's shanghai this channelListener's mNextListener if we want to convert the stream. if (!nsCRT::strcasecmp(contentType, "message/rfc822")) { from = "message/rfc822"; to = "text/xul"; conversionRequired = PR_TRUE; } else if (!nsCRT::strcasecmp(contentType, "multipart/x-mixed-replace")) { from = "multipart/x-mixed-replace"; to = "text/html"; conversionRequired = PR_TRUE; } if (conversionRequired) { NS_WITH_SERVICE(nsIStreamConverterService, StreamConvService, kStreamConverterServiceCID, &rv); if (NS_FAILED(rv)) return rv; // The following call binds this channelListener's mNextListener (typically // the nsDocumentBindInfo) to the underlying stream converter, and returns // the underlying stream converter which we then set to be this channelListener's // mNextListener. This effectively nestles the stream converter down right // in between the raw stream and the final listener. nsIStreamListener *converterListener = nsnull; rv = StreamConvService->AsyncConvertData(from.GetUnicode(), to.GetUnicode(), mNextListener, aChannel, &converterListener); mNextListener = converterListener; NS_IF_RELEASE(converterListener); } } ////////////////////////////// // END STREAM CONVERTERS ////////////////////////////// // Pass the notification to the next listener... rv = mNextListener->OnStartRequest(aChannel, aContext); // // Notify the document loader... nsCOMPtr container; NS_ENSURE_SUCCESS(mDocLoader->GetContainer(getter_AddRefs(container)), NS_ERROR_FAILURE); nsCOMPtr webShell(do_QueryInterface(container)); NS_ENSURE_TRUE(webShell, NS_ERROR_FAILURE); webShell->GetContentViewer(getter_AddRefs(viewer)); if (mDocLoader->IsLoadingDocument()) { nsLoadFlags loadAttribs; aChannel->GetLoadAttributes(&loadAttribs); if (!(loadAttribs & nsIChannel::LOAD_BACKGROUND)) { mDocLoader->FireOnStartURLLoad(mDocLoader, aChannel, viewer); } } return rv; } NS_IMETHODIMP nsChannelListener::OnStopRequest(nsIChannel *aChannel, nsISupports *aContext, nsresult aStatus, const PRUnichar *aMsg) { nsresult rv; rv = mNextListener->OnStopRequest(aChannel, aContext, aStatus, aMsg); if (mDocLoader->IsLoadingDocument()) { nsLoadFlags loadAttribs; aChannel->GetLoadAttributes(&loadAttribs); if (!(loadAttribs & nsIChannel::LOAD_BACKGROUND)) { mDocLoader->FireOnEndURLLoad(mDocLoader, aChannel, aStatus); } } return rv; } NS_IMETHODIMP nsChannelListener::OnDataAvailable(nsIChannel *aChannel, nsISupports *aContext, nsIInputStream *aInStream, PRUint32 aOffset, PRUint32 aCount) { return mNextListener->OnDataAvailable(aChannel, aContext, aInStream, aOffset, aCount); } /******************************************* * nsDocLoaderServiceFactory *******************************************/ static nsDocLoaderImpl* gServiceInstance = nsnull; NS_IMETHODIMP nsDocLoaderImpl::Create(nsISupports *aOuter, const nsIID &aIID, void **aResult) { nsresult rv; nsDocLoaderImpl* inst; // Parameter validation... if (NULL == aResult) { rv = NS_ERROR_NULL_POINTER; goto done; } // Do not support aggregatable components... *aResult = NULL; if (NULL != aOuter) { rv = NS_ERROR_NO_AGGREGATION; goto done; } if (NULL == gServiceInstance) { // Create a new instance of the component... NS_NEWXPCOM(gServiceInstance, nsDocLoaderImpl); if (NULL == gServiceInstance) { rv = NS_ERROR_OUT_OF_MEMORY; goto done; } } // If the QI fails, the component will be destroyed... // // Use a local copy so the NS_RELEASE() will not null the global // pointer... inst = gServiceInstance; NS_ADDREF(inst); rv = inst->QueryInterface(aIID, aResult); if (NS_SUCCEEDED(rv)) { rv = inst->Init(); } NS_RELEASE(inst); done: return rv; } // Entry point to create nsDocLoaderService factory instances... nsresult NS_NewDocLoaderServiceFactory(nsIFactory** aResult) { nsresult rv = NS_OK; nsIGenericFactory* factory; rv = nsComponentManager::CreateInstance(kGenericFactoryCID, nsnull, nsIGenericFactory::GetIID(), (void**)&factory); if (NS_FAILED(rv)) return rv; rv = factory->SetConstructor(nsDocLoaderImpl::Create); if (NS_FAILED(rv)) { NS_RELEASE(factory); return rv; } *aResult = factory; return rv; }