/* -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ /* ***** BEGIN LICENSE BLOCK ***** * Version: MPL 1.1/GPL 2.0/LGPL 2.1 * * The contents of this file are subject to the Mozilla 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/MPL/ * * 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.org code. * * The Initial Developer of the Original Code is * Mozilla Corporation * Portions created by the Initial Developer are Copyright (C) 2007 * the Initial Developer. All Rights Reserved. * * Contributor(s): * Dave Camp * * Alternatively, the contents of this file may be used under the terms of * either the GNU General Public License Version 2 or later (the "GPL"), or * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), * in which case the provisions of the GPL or the LGPL are applicable instead * of those above. If you wish to allow use of your version of this file only * under the terms of either the GPL or the LGPL, and not to allow others to * use your version of this file under the terms of the MPL, indicate your * decision by deleting the provisions above and replace them with the notice * and other provisions required by the GPL or the LGPL. If you do not delete * the provisions above, a recipient may use your version of this file under * the terms of any one of the MPL, the GPL or the LGPL. * * ***** END LICENSE BLOCK ***** */ #include "nsOfflineCacheUpdate.h" #include "nsCPrefetchService.h" #include "nsCURILoader.h" #include "nsIApplicationCacheContainer.h" #include "nsIApplicationCacheChannel.h" #include "nsIApplicationCacheService.h" #include "nsICache.h" #include "nsICacheService.h" #include "nsICacheSession.h" #include "nsICachingChannel.h" #include "nsIContent.h" #include "nsIDocumentLoader.h" #include "nsIDOMElement.h" #include "nsIDOMWindow.h" #include "nsIDOMOfflineResourceList.h" #include "nsIDocument.h" #include "nsIObserverService.h" #include "nsIURL.h" #include "nsIWebProgress.h" #include "nsICryptoHash.h" #include "nsICacheEntryDescriptor.h" #include "nsIPermissionManager.h" #include "nsIPrincipal.h" #include "nsIPrefBranch.h" #include "nsIPrefService.h" #include "nsNetCID.h" #include "nsNetUtil.h" #include "nsServiceManagerUtils.h" #include "nsStreamUtils.h" #include "nsThreadUtils.h" #include "nsProxyRelease.h" #include "prlog.h" static nsOfflineCacheUpdateService *gOfflineCacheUpdateService = nsnull; static const PRUint32 kRescheduleLimit = 3; #if defined(PR_LOGGING) // // To enable logging (see prlog.h for full details): // // set NSPR_LOG_MODULES=nsOfflineCacheUpdate:5 // set NSPR_LOG_FILE=offlineupdate.log // // this enables PR_LOG_ALWAYS level information and places all output in // the file offlineupdate.log // static PRLogModuleInfo *gOfflineCacheUpdateLog; #endif #define LOG(args) PR_LOG(gOfflineCacheUpdateLog, 4, args) #define LOG_ENABLED() PR_LOG_TEST(gOfflineCacheUpdateLog, 4) class AutoFreeArray { public: AutoFreeArray(PRUint32 count, char **values) : mCount(count), mValues(values) {}; ~AutoFreeArray() { NS_FREE_XPCOM_ALLOCATED_POINTER_ARRAY(mCount, mValues); } private: PRUint32 mCount; char **mValues; }; static nsresult DropReferenceFromURL(nsIURI * aURI) { nsCOMPtr url = do_QueryInterface(aURI); if (url) { nsresult rv = url->SetRef(EmptyCString()); NS_ENSURE_SUCCESS(rv, rv); } return NS_OK; } //----------------------------------------------------------------------------- // nsManifestCheck //----------------------------------------------------------------------------- class nsManifestCheck : public nsIStreamListener , public nsIChannelEventSink , public nsIInterfaceRequestor { public: nsManifestCheck(nsOfflineCacheUpdate *aUpdate, nsIURI *aURI, nsIURI *aReferrerURI) : mUpdate(aUpdate) , mURI(aURI) , mReferrerURI(aReferrerURI) {} NS_DECL_ISUPPORTS NS_DECL_NSIREQUESTOBSERVER NS_DECL_NSISTREAMLISTENER NS_DECL_NSICHANNELEVENTSINK NS_DECL_NSIINTERFACEREQUESTOR nsresult Begin(); private: static NS_METHOD ReadManifest(nsIInputStream *aInputStream, void *aClosure, const char *aFromSegment, PRUint32 aOffset, PRUint32 aCount, PRUint32 *aBytesConsumed); nsRefPtr mUpdate; nsCOMPtr mURI; nsCOMPtr mReferrerURI; nsCOMPtr mManifestHash; nsCOMPtr mChannel; }; //----------------------------------------------------------------------------- // nsManifestCheck::nsISupports //----------------------------------------------------------------------------- NS_IMPL_ISUPPORTS4(nsManifestCheck, nsIRequestObserver, nsIStreamListener, nsIChannelEventSink, nsIInterfaceRequestor) //----------------------------------------------------------------------------- // nsManifestCheck //----------------------------------------------------------------------------- nsresult nsManifestCheck::Begin() { nsresult rv; mManifestHash = do_CreateInstance("@mozilla.org/security/hash;1", &rv); NS_ENSURE_SUCCESS(rv, rv); rv = mManifestHash->Init(nsICryptoHash::MD5); NS_ENSURE_SUCCESS(rv, rv); rv = NS_NewChannel(getter_AddRefs(mChannel), mURI, nsnull, nsnull, nsnull, nsIRequest::LOAD_BYPASS_CACHE); NS_ENSURE_SUCCESS(rv, rv); // configure HTTP specific stuff nsCOMPtr httpChannel = do_QueryInterface(mChannel); if (httpChannel) { httpChannel->SetReferrer(mReferrerURI); httpChannel->SetRequestHeader(NS_LITERAL_CSTRING("X-Moz"), NS_LITERAL_CSTRING("offline-resource"), PR_FALSE); } rv = mChannel->AsyncOpen(this, nsnull); NS_ENSURE_SUCCESS(rv, rv); return NS_OK; } //----------------------------------------------------------------------------- // nsManifestCheck //----------------------------------------------------------------------------- /* static */ NS_METHOD nsManifestCheck::ReadManifest(nsIInputStream *aInputStream, void *aClosure, const char *aFromSegment, PRUint32 aOffset, PRUint32 aCount, PRUint32 *aBytesConsumed) { nsManifestCheck *manifestCheck = static_cast(aClosure); nsresult rv; *aBytesConsumed = aCount; rv = manifestCheck->mManifestHash->Update( reinterpret_cast(aFromSegment), aCount); NS_ENSURE_SUCCESS(rv, rv); return NS_OK; } //----------------------------------------------------------------------------- // nsManifestCheck::nsIStreamListener //----------------------------------------------------------------------------- NS_IMETHODIMP nsManifestCheck::OnStartRequest(nsIRequest *aRequest, nsISupports *aContext) { return NS_OK; } NS_IMETHODIMP nsManifestCheck::OnDataAvailable(nsIRequest *aRequest, nsISupports *aContext, nsIInputStream *aStream, PRUint32 aOffset, PRUint32 aCount) { PRUint32 bytesRead; aStream->ReadSegments(ReadManifest, this, aCount, &bytesRead); return NS_OK; } NS_IMETHODIMP nsManifestCheck::OnStopRequest(nsIRequest *aRequest, nsISupports *aContext, nsresult aStatus) { nsCAutoString manifestHash; if (NS_SUCCEEDED(aStatus)) { mManifestHash->Finish(PR_TRUE, manifestHash); } mUpdate->ManifestCheckCompleted(aStatus, manifestHash); return NS_OK; } //----------------------------------------------------------------------------- // nsManifestCheck::nsIInterfaceRequestor //----------------------------------------------------------------------------- NS_IMETHODIMP nsManifestCheck::GetInterface(const nsIID &aIID, void **aResult) { if (aIID.Equals(NS_GET_IID(nsIChannelEventSink))) { NS_ADDREF_THIS(); *aResult = static_cast(this); return NS_OK; } return NS_ERROR_NO_INTERFACE; } //----------------------------------------------------------------------------- // nsManifestCheck::nsIChannelEventSink //----------------------------------------------------------------------------- NS_IMETHODIMP nsManifestCheck::OnChannelRedirect(nsIChannel *aOldChannel, nsIChannel *aNewChannel, PRUint32 aFlags) { // Redirects should cause the load (and therefore the update) to fail. if (aFlags & nsIChannelEventSink::REDIRECT_INTERNAL) return NS_OK; aOldChannel->Cancel(NS_ERROR_ABORT); return NS_ERROR_ABORT; } //----------------------------------------------------------------------------- // nsOfflineCacheUpdateItem::nsISupports //----------------------------------------------------------------------------- NS_IMPL_ISUPPORTS6(nsOfflineCacheUpdateItem, nsIDOMLoadStatus, nsIRequestObserver, nsIStreamListener, nsIRunnable, nsIInterfaceRequestor, nsIChannelEventSink) //----------------------------------------------------------------------------- // nsOfflineCacheUpdateItem //----------------------------------------------------------------------------- nsOfflineCacheUpdateItem::nsOfflineCacheUpdateItem(nsOfflineCacheUpdate *aUpdate, nsIURI *aURI, nsIURI *aReferrerURI, nsIApplicationCache *aPreviousApplicationCache, const nsACString &aClientID, PRUint32 type) : mURI(aURI) , mReferrerURI(aReferrerURI) , mPreviousApplicationCache(aPreviousApplicationCache) , mClientID(aClientID) , mItemType(type) , mUpdate(aUpdate) , mChannel(nsnull) , mState(nsIDOMLoadStatus::UNINITIALIZED) , mBytesRead(0) { } nsOfflineCacheUpdateItem::~nsOfflineCacheUpdateItem() { } nsresult nsOfflineCacheUpdateItem::OpenChannel() { #if defined(PR_LOGGING) if (LOG_ENABLED()) { nsCAutoString spec; mURI->GetSpec(spec); LOG(("%p: Opening channel for %s", this, spec.get())); } #endif nsresult rv = nsOfflineCacheUpdate::GetCacheKey(mURI, mCacheKey); NS_ENSURE_SUCCESS(rv, rv); rv = NS_NewChannel(getter_AddRefs(mChannel), mURI, nsnull, nsnull, this, nsIRequest::LOAD_BACKGROUND | nsICachingChannel::LOAD_ONLY_IF_MODIFIED | nsICachingChannel::LOAD_CHECK_OFFLINE_CACHE); NS_ENSURE_SUCCESS(rv, rv); nsCOMPtr appCacheChannel = do_QueryInterface(mChannel, &rv); // Support for nsIApplicationCacheChannel is required. NS_ENSURE_SUCCESS(rv, rv); // Use the existing application cache as the cache to check. rv = appCacheChannel->SetApplicationCache(mPreviousApplicationCache); NS_ENSURE_SUCCESS(rv, rv); // configure HTTP specific stuff nsCOMPtr httpChannel = do_QueryInterface(mChannel); if (httpChannel) { httpChannel->SetReferrer(mReferrerURI); httpChannel->SetRequestHeader(NS_LITERAL_CSTRING("X-Moz"), NS_LITERAL_CSTRING("offline-resource"), PR_FALSE); } nsCOMPtr cachingChannel = do_QueryInterface(mChannel); if (cachingChannel) { rv = cachingChannel->SetCacheForOfflineUse(PR_TRUE); NS_ENSURE_SUCCESS(rv, rv); if (!mClientID.IsEmpty()) { rv = cachingChannel->SetOfflineCacheClientID(mClientID); NS_ENSURE_SUCCESS(rv, rv); } } rv = mChannel->AsyncOpen(this, nsnull); NS_ENSURE_SUCCESS(rv, rv); mState = nsIDOMLoadStatus::REQUESTED; return NS_OK; } nsresult nsOfflineCacheUpdateItem::Cancel() { if (mChannel) { mChannel->Cancel(NS_ERROR_ABORT); mChannel = nsnull; } mState = nsIDOMLoadStatus::UNINITIALIZED; return NS_OK; } //----------------------------------------------------------------------------- // nsOfflineCacheUpdateItem::nsIStreamListener //----------------------------------------------------------------------------- NS_IMETHODIMP nsOfflineCacheUpdateItem::OnStartRequest(nsIRequest *aRequest, nsISupports *aContext) { mState = nsIDOMLoadStatus::RECEIVING; return NS_OK; } NS_IMETHODIMP nsOfflineCacheUpdateItem::OnDataAvailable(nsIRequest *aRequest, nsISupports *aContext, nsIInputStream *aStream, PRUint32 aOffset, PRUint32 aCount) { PRUint32 bytesRead = 0; aStream->ReadSegments(NS_DiscardSegment, nsnull, aCount, &bytesRead); mBytesRead += bytesRead; LOG(("loaded %u bytes into offline cache [offset=%u]\n", bytesRead, aOffset)); return NS_OK; } NS_IMETHODIMP nsOfflineCacheUpdateItem::OnStopRequest(nsIRequest *aRequest, nsISupports *aContext, nsresult aStatus) { LOG(("done fetching offline item [status=%x]\n", aStatus)); mState = nsIDOMLoadStatus::LOADED; if (mBytesRead == 0 && aStatus == NS_OK) { // we didn't need to read (because LOAD_ONLY_IF_MODIFIED was // specified), but the object should report loadedSize as if it // did. mChannel->GetContentLength(&mBytesRead); } // We need to notify the update that the load is complete, but we // want to give the channel a chance to close the cache entries. NS_DispatchToCurrentThread(this); return NS_OK; } //----------------------------------------------------------------------------- // nsOfflineCacheUpdateItem::nsIRunnable //----------------------------------------------------------------------------- NS_IMETHODIMP nsOfflineCacheUpdateItem::Run() { mUpdate->LoadCompleted(); return NS_OK; } //----------------------------------------------------------------------------- // nsOfflineCacheUpdateItem::nsIInterfaceRequestor //----------------------------------------------------------------------------- NS_IMETHODIMP nsOfflineCacheUpdateItem::GetInterface(const nsIID &aIID, void **aResult) { if (aIID.Equals(NS_GET_IID(nsIChannelEventSink))) { NS_ADDREF_THIS(); *aResult = static_cast(this); return NS_OK; } return NS_ERROR_NO_INTERFACE; } //----------------------------------------------------------------------------- // nsOfflineCacheUpdateItem::nsIChannelEventSink //----------------------------------------------------------------------------- NS_IMETHODIMP nsOfflineCacheUpdateItem::OnChannelRedirect(nsIChannel *aOldChannel, nsIChannel *aNewChannel, PRUint32 aFlags) { nsCOMPtr newURI; nsresult rv = aNewChannel->GetURI(getter_AddRefs(newURI)); if (NS_FAILED(rv)) return rv; nsCOMPtr oldCachingChannel = do_QueryInterface(aOldChannel); nsCOMPtr newCachingChannel = do_QueryInterface(aOldChannel); if (newCachingChannel) { rv = newCachingChannel->SetCacheForOfflineUse(PR_TRUE); NS_ENSURE_SUCCESS(rv, rv); if (!mClientID.IsEmpty()) { rv = newCachingChannel->SetOfflineCacheClientID(mClientID); NS_ENSURE_SUCCESS(rv, rv); } } nsCAutoString oldScheme; mURI->GetScheme(oldScheme); PRBool match; if (NS_FAILED(newURI->SchemeIs(oldScheme.get(), &match)) || !match) { LOG(("rejected: redirected to a different scheme\n")); return NS_ERROR_ABORT; } // HTTP request headers are not automatically forwarded to the new channel. nsCOMPtr httpChannel = do_QueryInterface(aNewChannel); NS_ENSURE_STATE(httpChannel); httpChannel->SetRequestHeader(NS_LITERAL_CSTRING("X-Moz"), NS_LITERAL_CSTRING("offline-resource"), PR_FALSE); mChannel = aNewChannel; return NS_OK; } //----------------------------------------------------------------------------- // nsOfflineCacheUpdateItem::nsIDOMLoadStatus //----------------------------------------------------------------------------- NS_IMETHODIMP nsOfflineCacheUpdateItem::GetSource(nsIDOMNode **aSource) { *aSource = nsnull; return NS_OK; } NS_IMETHODIMP nsOfflineCacheUpdateItem::GetUri(nsAString &aURI) { nsCAutoString spec; nsresult rv = mURI->GetSpec(spec); NS_ENSURE_SUCCESS(rv, rv); CopyUTF8toUTF16(spec, aURI); return NS_OK; } NS_IMETHODIMP nsOfflineCacheUpdateItem::GetTotalSize(PRInt32 *aTotalSize) { if (mChannel) { return mChannel->GetContentLength(aTotalSize); } *aTotalSize = -1; return NS_OK; } NS_IMETHODIMP nsOfflineCacheUpdateItem::GetLoadedSize(PRInt32 *aLoadedSize) { *aLoadedSize = mBytesRead; return NS_OK; } NS_IMETHODIMP nsOfflineCacheUpdateItem::GetReadyState(PRUint16 *aReadyState) { *aReadyState = mState; return NS_OK; } NS_IMETHODIMP nsOfflineCacheUpdateItem::GetStatus(PRUint16 *aStatus) { if (!mChannel) { *aStatus = 0; return NS_OK; } nsresult rv; nsCOMPtr httpChannel = do_QueryInterface(mChannel, &rv); NS_ENSURE_SUCCESS(rv, rv); PRUint32 httpStatus; rv = httpChannel->GetResponseStatus(&httpStatus); if (rv == NS_ERROR_NOT_AVAILABLE) { // Someone's calling this before we got a response... Check our // ReadyState. If we're at RECEIVING or LOADED, then this means the // connection errored before we got any data; return a somewhat // sensible error code in that case. if (mState >= nsIDOMLoadStatus::RECEIVING) { *aStatus = NS_ERROR_NOT_AVAILABLE; return NS_OK; } *aStatus = 0; return NS_OK; } NS_ENSURE_SUCCESS(rv, rv); *aStatus = PRUint16(httpStatus); return NS_OK; } //----------------------------------------------------------------------------- // nsOfflineManifestItem //----------------------------------------------------------------------------- //----------------------------------------------------------------------------- // nsOfflineManifestItem //----------------------------------------------------------------------------- nsOfflineManifestItem::nsOfflineManifestItem(nsOfflineCacheUpdate *aUpdate, nsIURI *aURI, nsIURI *aReferrerURI, nsIApplicationCache *aPreviousApplicationCache, const nsACString &aClientID) : nsOfflineCacheUpdateItem(aUpdate, aURI, aReferrerURI, aPreviousApplicationCache, aClientID, nsIApplicationCache::ITEM_MANIFEST) , mParserState(PARSE_INIT) , mNeedsUpdate(PR_TRUE) , mManifestHashInitialized(PR_FALSE) { ReadStrictFileOriginPolicyPref(); } nsOfflineManifestItem::~nsOfflineManifestItem() { } //----------------------------------------------------------------------------- // nsOfflineManifestItem //----------------------------------------------------------------------------- /* static */ NS_METHOD nsOfflineManifestItem::ReadManifest(nsIInputStream *aInputStream, void *aClosure, const char *aFromSegment, PRUint32 aOffset, PRUint32 aCount, PRUint32 *aBytesConsumed) { nsOfflineManifestItem *manifest = static_cast(aClosure); nsresult rv; *aBytesConsumed = aCount; if (manifest->mParserState == PARSE_ERROR) { // parse already failed, ignore this return NS_OK; } if (!manifest->mManifestHashInitialized) { // Avoid re-creation of crypto hash when it fails from some reason the first time manifest->mManifestHashInitialized = PR_TRUE; manifest->mManifestHash = do_CreateInstance("@mozilla.org/security/hash;1", &rv); if (NS_SUCCEEDED(rv)) { rv = manifest->mManifestHash->Init(nsICryptoHash::MD5); if (NS_FAILED(rv)) { manifest->mManifestHash = nsnull; LOG(("Could not initialize manifest hash for byte-to-byte check, rv=%08x", rv)); } } } if (manifest->mManifestHash) { rv = manifest->mManifestHash->Update(reinterpret_cast(aFromSegment), aCount); if (NS_FAILED(rv)) { manifest->mManifestHash = nsnull; LOG(("Could not update manifest hash, rv=%08x", rv)); } } manifest->mReadBuf.Append(aFromSegment, aCount); nsCString::const_iterator begin, iter, end; manifest->mReadBuf.BeginReading(begin); manifest->mReadBuf.EndReading(end); for (iter = begin; iter != end; iter++) { if (*iter == '\r' || *iter == '\n') { nsresult rv = manifest->HandleManifestLine(begin, iter); if (NS_FAILED(rv)) { LOG(("HandleManifestLine failed with 0x%08x", rv)); return NS_ERROR_ABORT; } begin = iter; begin++; } } // any leftovers are saved for next time manifest->mReadBuf = Substring(begin, end); return NS_OK; } nsresult nsOfflineManifestItem::AddNamespace(PRUint32 namespaceType, const nsCString &namespaceSpec, const nsCString &data) { nsresult rv; if (!mNamespaces) { mNamespaces = do_CreateInstance(NS_ARRAY_CONTRACTID, &rv); NS_ENSURE_SUCCESS(rv, rv); } nsCOMPtr ns = do_CreateInstance(NS_APPLICATIONCACHENAMESPACE_CONTRACTID, &rv); NS_ENSURE_SUCCESS(rv, rv); rv = ns->Init(namespaceType, namespaceSpec, data); NS_ENSURE_SUCCESS(rv, rv); rv = mNamespaces->AppendElement(ns, PR_FALSE); NS_ENSURE_SUCCESS(rv, rv); return NS_OK; } nsresult nsOfflineManifestItem::HandleManifestLine(const nsCString::const_iterator &aBegin, const nsCString::const_iterator &aEnd) { nsCString::const_iterator begin = aBegin; nsCString::const_iterator end = aEnd; // all lines ignore trailing spaces and tabs nsCString::const_iterator last = end; --last; while (end != begin && (*last == ' ' || *last == '\t')) { --end; --last; } if (mParserState == PARSE_INIT) { // Allow a UTF-8 BOM if (begin != end && static_cast(*begin) == 0xef) { if (++begin == end || static_cast(*begin) != 0xbb || ++begin == end || static_cast(*begin) != 0xbf) { mParserState = PARSE_ERROR; return NS_OK; } ++begin; } const nsCSubstring &magic = Substring(begin, end); if (!magic.EqualsLiteral("CACHE MANIFEST")) { mParserState = PARSE_ERROR; return NS_OK; } mParserState = PARSE_CACHE_ENTRIES; return NS_OK; } // lines other than the first ignore leading spaces and tabs while (begin != end && (*begin == ' ' || *begin == '\t')) begin++; // ignore blank lines and comments if (begin == end || *begin == '#') return NS_OK; const nsCSubstring &line = Substring(begin, end); if (line.EqualsLiteral("CACHE:")) { mParserState = PARSE_CACHE_ENTRIES; return NS_OK; } if (line.EqualsLiteral("FALLBACK:")) { mParserState = PARSE_FALLBACK_ENTRIES; return NS_OK; } if (line.EqualsLiteral("NETWORK:")) { mParserState = PARSE_BYPASS_ENTRIES; return NS_OK; } nsresult rv; switch(mParserState) { case PARSE_INIT: case PARSE_ERROR: { // this should have been dealt with earlier return NS_ERROR_FAILURE; } case PARSE_CACHE_ENTRIES: { nsCOMPtr uri; rv = NS_NewURI(getter_AddRefs(uri), line, nsnull, mURI); if (NS_FAILED(rv)) break; if (NS_FAILED(DropReferenceFromURL(uri))) break; nsCAutoString scheme; uri->GetScheme(scheme); // Manifest URIs must have the same scheme as the manifest. PRBool match; if (NS_FAILED(mURI->SchemeIs(scheme.get(), &match)) || !match) break; mExplicitURIs.AppendObject(uri); break; } case PARSE_FALLBACK_ENTRIES: { PRInt32 separator = line.FindChar(' '); if (separator == kNotFound) { separator = line.FindChar('\t'); if (separator == kNotFound) break; } nsCString namespaceSpec(Substring(line, 0, separator)); nsCString fallbackSpec(Substring(line, separator + 1)); namespaceSpec.CompressWhitespace(); fallbackSpec.CompressWhitespace(); nsCOMPtr namespaceURI; rv = NS_NewURI(getter_AddRefs(namespaceURI), namespaceSpec, nsnull, mURI); if (NS_FAILED(rv)) break; if (NS_FAILED(DropReferenceFromURL(namespaceURI))) break; rv = namespaceURI->GetAsciiSpec(namespaceSpec); if (NS_FAILED(rv)) break; nsCOMPtr fallbackURI; rv = NS_NewURI(getter_AddRefs(fallbackURI), fallbackSpec, nsnull, mURI); if (NS_FAILED(rv)) break; if (NS_FAILED(DropReferenceFromURL(fallbackURI))) break; rv = fallbackURI->GetAsciiSpec(fallbackSpec); if (NS_FAILED(rv)) break; // Manifest and namespace must be same origin if (!NS_SecurityCompareURIs(mURI, namespaceURI, mStrictFileOriginPolicy)) break; // Fallback and namespace must be same origin if (!NS_SecurityCompareURIs(namespaceURI, fallbackURI, mStrictFileOriginPolicy)) break; mFallbackURIs.AppendObject(fallbackURI); AddNamespace(nsIApplicationCacheNamespace::NAMESPACE_FALLBACK, namespaceSpec, fallbackSpec); break; } case PARSE_BYPASS_ENTRIES: { nsCOMPtr bypassURI; rv = NS_NewURI(getter_AddRefs(bypassURI), line, nsnull, mURI); if (NS_FAILED(rv)) break; nsCAutoString scheme; bypassURI->GetScheme(scheme); PRBool equals; if (NS_FAILED(mURI->SchemeIs(scheme.get(), &equals)) || !equals) break; if (NS_FAILED(DropReferenceFromURL(bypassURI))) break; nsCString spec; if (NS_FAILED(bypassURI->GetAsciiSpec(spec))) break; AddNamespace(nsIApplicationCacheNamespace::NAMESPACE_BYPASS, spec, EmptyCString()); break; } } return NS_OK; } nsresult nsOfflineManifestItem::GetOldManifestContentHash(nsIRequest *aRequest) { nsresult rv; nsCOMPtr cachingChannel = do_QueryInterface(aRequest, &rv); NS_ENSURE_SUCCESS(rv, rv); // load the main cache token that is actually the old offline cache token and // read previous manifest content hash value nsCOMPtr cacheToken; cachingChannel->GetCacheToken(getter_AddRefs(cacheToken)); if (cacheToken) { nsCOMPtr cacheDescriptor(do_QueryInterface(cacheToken, &rv)); NS_ENSURE_SUCCESS(rv, rv); rv = cacheDescriptor->GetMetaDataElement("offline-manifest-hash", getter_Copies(mOldManifestHashValue)); if (NS_FAILED(rv)) mOldManifestHashValue.Truncate(); } return NS_OK; } nsresult nsOfflineManifestItem::CheckNewManifestContentHash(nsIRequest *aRequest) { nsresult rv; if (!mManifestHash) { // Nothing to compare against... return NS_OK; } nsCString newManifestHashValue; rv = mManifestHash->Finish(PR_TRUE, mManifestHashValue); mManifestHash = nsnull; if (NS_FAILED(rv)) { LOG(("Could not finish manifest hash, rv=%08x", rv)); // This is not critical error return NS_OK; } if (!ParseSucceeded()) { // Parsing failed, the hash is not valid return NS_OK; } if (mOldManifestHashValue == mManifestHashValue) { LOG(("Update not needed, downloaded manifest content is byte-for-byte identical")); mNeedsUpdate = PR_FALSE; } // Store the manifest content hash value to the new // offline cache token nsCOMPtr cachingChannel = do_QueryInterface(aRequest, &rv); NS_ENSURE_SUCCESS(rv, rv); nsCOMPtr cacheToken; cachingChannel->GetOfflineCacheToken(getter_AddRefs(cacheToken)); if (cacheToken) { nsCOMPtr cacheDescriptor(do_QueryInterface(cacheToken, &rv)); NS_ENSURE_SUCCESS(rv, rv); rv = cacheDescriptor->SetMetaDataElement("offline-manifest-hash", mManifestHashValue.get()); NS_ENSURE_SUCCESS(rv, rv); } return NS_OK; } void nsOfflineManifestItem::ReadStrictFileOriginPolicyPref() { nsCOMPtr prefs = do_GetService(NS_PREFSERVICE_CONTRACTID); mStrictFileOriginPolicy = (!prefs || NS_FAILED(prefs->GetBoolPref("security.fileuri.strict_origin_policy", &mStrictFileOriginPolicy))); } NS_IMETHODIMP nsOfflineManifestItem::OnStartRequest(nsIRequest *aRequest, nsISupports *aContext) { nsresult rv; nsCOMPtr channel = do_QueryInterface(aRequest, &rv); NS_ENSURE_SUCCESS(rv, rv); PRBool succeeded; rv = channel->GetRequestSucceeded(&succeeded); NS_ENSURE_SUCCESS(rv, rv); if (!succeeded) { LOG(("HTTP request failed")); mParserState = PARSE_ERROR; return NS_ERROR_ABORT; } nsCAutoString contentType; rv = channel->GetContentType(contentType); NS_ENSURE_SUCCESS(rv, rv); if (!contentType.EqualsLiteral("text/cache-manifest")) { LOG(("Rejected cache manifest with Content-Type %s (expecting text/cache-manifest)", contentType.get())); mParserState = PARSE_ERROR; return NS_ERROR_ABORT; } rv = GetOldManifestContentHash(aRequest); NS_ENSURE_SUCCESS(rv, rv); return nsOfflineCacheUpdateItem::OnStartRequest(aRequest, aContext); } NS_IMETHODIMP nsOfflineManifestItem::OnDataAvailable(nsIRequest *aRequest, nsISupports *aContext, nsIInputStream *aStream, PRUint32 aOffset, PRUint32 aCount) { PRUint32 bytesRead = 0; aStream->ReadSegments(ReadManifest, this, aCount, &bytesRead); mBytesRead += bytesRead; if (mParserState == PARSE_ERROR) { LOG(("OnDataAvailable is canceling the request due a parse error\n")); return NS_ERROR_ABORT; } LOG(("loaded %u bytes into offline cache [offset=%u]\n", bytesRead, aOffset)); // All the parent method does is read and discard, don't bother // chaining up. return NS_OK; } NS_IMETHODIMP nsOfflineManifestItem::OnStopRequest(nsIRequest *aRequest, nsISupports *aContext, nsresult aStatus) { // handle any leftover manifest data nsCString::const_iterator begin, end; mReadBuf.BeginReading(begin); mReadBuf.EndReading(end); nsresult rv = HandleManifestLine(begin, end); NS_ENSURE_SUCCESS(rv, rv); if (mBytesRead == 0) { // we didn't need to read (because LOAD_ONLY_IF_MODIFIED was // specified.) mNeedsUpdate = PR_FALSE; } else { rv = CheckNewManifestContentHash(aRequest); NS_ENSURE_SUCCESS(rv, rv); } return nsOfflineCacheUpdateItem::OnStopRequest(aRequest, aContext, aStatus); } //----------------------------------------------------------------------------- // nsOfflineCacheUpdate::nsISupports //----------------------------------------------------------------------------- NS_IMPL_ISUPPORTS1(nsOfflineCacheUpdate, nsIOfflineCacheUpdate) //----------------------------------------------------------------------------- // nsOfflineCacheUpdate //----------------------------------------------------------------------------- nsOfflineCacheUpdate::nsOfflineCacheUpdate() : mState(STATE_UNINITIALIZED) , mOwner(nsnull) , mAddedItems(PR_FALSE) , mPartialUpdate(PR_FALSE) , mSucceeded(PR_TRUE) , mObsolete(PR_FALSE) , mCurrentItem(-1) , mRescheduleCount(0) { } nsOfflineCacheUpdate::~nsOfflineCacheUpdate() { LOG(("nsOfflineCacheUpdate::~nsOfflineCacheUpdate [%p]", this)); } /* static */ nsresult nsOfflineCacheUpdate::GetCacheKey(nsIURI *aURI, nsACString &aKey) { aKey.Truncate(); nsCOMPtr newURI; nsresult rv = aURI->Clone(getter_AddRefs(newURI)); NS_ENSURE_SUCCESS(rv, rv); nsCOMPtr newURL; newURL = do_QueryInterface(newURI); if (newURL) { newURL->SetRef(EmptyCString()); } rv = newURI->GetAsciiSpec(aKey); NS_ENSURE_SUCCESS(rv, rv); return NS_OK; } nsresult nsOfflineCacheUpdate::Init(nsIURI *aManifestURI, nsIURI *aDocumentURI) { nsresult rv; // Make sure the service has been initialized nsOfflineCacheUpdateService* service = nsOfflineCacheUpdateService::EnsureService(); if (!service) return NS_ERROR_FAILURE; LOG(("nsOfflineCacheUpdate::Init [%p]", this)); mPartialUpdate = PR_FALSE; // Only http and https applications are supported. PRBool match; rv = aManifestURI->SchemeIs("http", &match); NS_ENSURE_SUCCESS(rv, rv); if (!match) { rv = aManifestURI->SchemeIs("https", &match); NS_ENSURE_SUCCESS(rv, rv); if (!match) return NS_ERROR_ABORT; } mManifestURI = aManifestURI; rv = mManifestURI->GetAsciiHost(mUpdateDomain); NS_ENSURE_SUCCESS(rv, rv); nsCAutoString manifestSpec; rv = GetCacheKey(mManifestURI, manifestSpec); NS_ENSURE_SUCCESS(rv, rv); mDocumentURI = aDocumentURI; nsCOMPtr cacheService = do_GetService(NS_APPLICATIONCACHESERVICE_CONTRACTID, &rv); NS_ENSURE_SUCCESS(rv, rv); rv = cacheService->GetActiveCache(manifestSpec, getter_AddRefs(mPreviousApplicationCache)); NS_ENSURE_SUCCESS(rv, rv); rv = cacheService->CreateApplicationCache(manifestSpec, getter_AddRefs(mApplicationCache)); NS_ENSURE_SUCCESS(rv, rv); rv = mApplicationCache->GetClientID(mClientID); NS_ENSURE_SUCCESS(rv, rv); mState = STATE_INITIALIZED; return NS_OK; } nsresult nsOfflineCacheUpdate::InitPartial(nsIURI *aManifestURI, const nsACString& clientID, nsIURI *aDocumentURI) { nsresult rv; // Make sure the service has been initialized nsOfflineCacheUpdateService* service = nsOfflineCacheUpdateService::EnsureService(); if (!service) return NS_ERROR_FAILURE; LOG(("nsOfflineCacheUpdate::InitPartial [%p]", this)); mPartialUpdate = PR_TRUE; mClientID = clientID; mDocumentURI = aDocumentURI; mManifestURI = aManifestURI; rv = mManifestURI->GetAsciiHost(mUpdateDomain); NS_ENSURE_SUCCESS(rv, rv); nsCOMPtr cacheService = do_GetService(NS_APPLICATIONCACHESERVICE_CONTRACTID, &rv); NS_ENSURE_SUCCESS(rv, rv); rv = cacheService->GetApplicationCache(mClientID, getter_AddRefs(mApplicationCache)); NS_ENSURE_SUCCESS(rv, rv); if (!mApplicationCache) { nsCAutoString manifestSpec; rv = GetCacheKey(mManifestURI, manifestSpec); NS_ENSURE_SUCCESS(rv, rv); rv = cacheService->CreateApplicationCache (manifestSpec, getter_AddRefs(mApplicationCache)); NS_ENSURE_SUCCESS(rv, rv); } nsCAutoString groupID; rv = mApplicationCache->GetGroupID(groupID); NS_ENSURE_SUCCESS(rv, rv); rv = NS_NewURI(getter_AddRefs(mManifestURI), groupID); NS_ENSURE_SUCCESS(rv, rv); mState = STATE_INITIALIZED; return NS_OK; } nsresult nsOfflineCacheUpdate::HandleManifest(PRBool *aDoUpdate) { // Be pessimistic *aDoUpdate = PR_FALSE; PRUint16 status; nsresult rv = mManifestItem->GetStatus(&status); NS_ENSURE_SUCCESS(rv, rv); if (status == 0 || status >= 400 || !mManifestItem->ParseSucceeded()) { return NS_ERROR_FAILURE; } if (!mManifestItem->NeedsUpdate()) { return NS_OK; } // Add items requested by the manifest. const nsCOMArray &manifestURIs = mManifestItem->GetExplicitURIs(); for (PRInt32 i = 0; i < manifestURIs.Count(); i++) { rv = AddURI(manifestURIs[i], nsIApplicationCache::ITEM_EXPLICIT); NS_ENSURE_SUCCESS(rv, rv); } const nsCOMArray &fallbackURIs = mManifestItem->GetFallbackURIs(); for (PRInt32 i = 0; i < fallbackURIs.Count(); i++) { rv = AddURI(fallbackURIs[i], nsIApplicationCache::ITEM_FALLBACK); NS_ENSURE_SUCCESS(rv, rv); } // The document that requested the manifest is implicitly included // as part of that manifest update. rv = AddURI(mDocumentURI, nsIApplicationCache::ITEM_IMPLICIT); NS_ENSURE_SUCCESS(rv, rv); // Add items previously cached implicitly rv = AddExistingItems(nsIApplicationCache::ITEM_IMPLICIT); NS_ENSURE_SUCCESS(rv, rv); // Add items requested by the script API rv = AddExistingItems(nsIApplicationCache::ITEM_DYNAMIC); NS_ENSURE_SUCCESS(rv, rv); // Add opportunistically cached items conforming current opportunistic // namespace list rv = AddExistingItems(nsIApplicationCache::ITEM_OPPORTUNISTIC, &mManifestItem->GetOpportunisticNamespaces()); NS_ENSURE_SUCCESS(rv, rv); *aDoUpdate = PR_TRUE; return NS_OK; } void nsOfflineCacheUpdate::LoadCompleted() { nsresult rv; LOG(("nsOfflineCacheUpdate::LoadCompleted [%p]", this)); if (mState == STATE_CANCELLED) { Finish(); return; } if (mState == STATE_CHECKING) { // Manifest load finished. NS_ASSERTION(mManifestItem, "Must have a manifest item in STATE_CHECKING."); // A 404 or 410 is interpreted as an intentional removal of // the manifest file, rather than a transient server error. // Obsolete this cache group if one of these is returned. PRUint16 status; rv = mManifestItem->GetStatus(&status); if (status == 404 || status == 410) { mSucceeded = PR_FALSE; mObsolete = PR_TRUE; if (mPreviousApplicationCache) { NotifyObsolete(); } else { NotifyError(); } Finish(); return; } PRBool doUpdate; if (NS_FAILED(HandleManifest(&doUpdate))) { mSucceeded = PR_FALSE; NotifyError(); Finish(); return; } if (!doUpdate) { mSucceeded = PR_FALSE; for (PRInt32 i = 0; i < mDocuments.Count(); i++) { printf("(Bug 471227) Associating from noupdate\n"); AssociateDocument(mDocuments[i]); } ScheduleImplicit(); // If we didn't need an implicit update, we can // send noupdate and end the update now. if (!mImplicitUpdate) { NotifyNoUpdate(); Finish(); } return; } rv = mApplicationCache->MarkEntry(mManifestItem->mCacheKey, mManifestItem->mItemType); if (NS_FAILED(rv)) { mSucceeded = PR_FALSE; NotifyError(); Finish(); return; } mState = STATE_DOWNLOADING; NotifyDownloading(); // Start fetching resources. ProcessNextURI(); return; } // Normal load finished. nsRefPtr item = mItems[mCurrentItem]; mCurrentItem++; PRUint16 status; rv = item->GetStatus(&status); // Check for failures. 4XX and 5XX errors on items explicitly // listed in the manifest will cause the update to fail. if (NS_FAILED(rv) || status == 0 || status >= 400) { if (item->mItemType & (nsIApplicationCache::ITEM_EXPLICIT | nsIApplicationCache::ITEM_FALLBACK)) { mSucceeded = PR_FALSE; } } else { rv = mApplicationCache->MarkEntry(item->mCacheKey, item->mItemType); if (NS_FAILED(rv)) { mSucceeded = PR_FALSE; } } if (!mSucceeded) { NotifyError(); Finish(); return; } rv = NotifyCompleted(item); if (NS_FAILED(rv)) return; ProcessNextURI(); } void nsOfflineCacheUpdate::ManifestCheckCompleted(nsresult aStatus, const nsCString &aManifestHash) { if (NS_SUCCEEDED(aStatus)) { nsCAutoString firstManifestHash; mManifestItem->GetManifestHash(firstManifestHash); if (aManifestHash != firstManifestHash) { aStatus = NS_ERROR_FAILURE; } } if (NS_FAILED(aStatus)) { mSucceeded = PR_FALSE; NotifyError(); } Finish(); if (NS_FAILED(aStatus) && mRescheduleCount < kRescheduleLimit) { printf("(Bug 471227) Rescheduling for manifest failure\n"); // Reschedule this update. nsRefPtr newUpdate = new nsOfflineCacheUpdate(); newUpdate->Init(mManifestURI, mDocumentURI); for (PRInt32 i = 0; i < mDocuments.Count(); i++) { newUpdate->AddDocument(mDocuments[i]); } newUpdate->mRescheduleCount = mRescheduleCount + 1; newUpdate->Schedule(); } } nsresult nsOfflineCacheUpdate::Begin() { LOG(("nsOfflineCacheUpdate::Begin [%p]", this)); mCurrentItem = 0; if (mPartialUpdate) { mState = STATE_DOWNLOADING; NotifyDownloading(); ProcessNextURI(); return NS_OK; } // Start checking the manifest. nsCOMPtr uri; mManifestItem = new nsOfflineManifestItem(this, mManifestURI, mDocumentURI, mPreviousApplicationCache, mClientID); if (!mManifestItem) { return NS_ERROR_OUT_OF_MEMORY; } mState = STATE_CHECKING; NotifyChecking(); nsresult rv = mManifestItem->OpenChannel(); if (NS_FAILED(rv)) { LoadCompleted(); } return NS_OK; } nsresult nsOfflineCacheUpdate::Cancel() { LOG(("nsOfflineCacheUpdate::Cancel [%p]", this)); mState = STATE_CANCELLED; mSucceeded = PR_FALSE; if (mCurrentItem >= 0 && mCurrentItem < static_cast(mItems.Length())) { // Load might be running mItems[mCurrentItem]->Cancel(); } return NS_OK; } //----------------------------------------------------------------------------- // nsOfflineCacheUpdate //----------------------------------------------------------------------------- nsresult nsOfflineCacheUpdate::AddExistingItems(PRUint32 aType, nsTArray* namespaceFilter) { if (!mPreviousApplicationCache) { return NS_OK; } if (namespaceFilter && namespaceFilter->Length() == 0) { // Don't bother to walk entries when there are no namespaces // defined. return NS_OK; } PRUint32 count = 0; char **keys = nsnull; nsresult rv = mPreviousApplicationCache->GatherEntries(aType, &count, &keys); NS_ENSURE_SUCCESS(rv, rv); AutoFreeArray autoFree(count, keys); for (PRUint32 i = 0; i < count; i++) { if (namespaceFilter) { PRBool found = PR_FALSE; for (PRUint32 j = 0; j < namespaceFilter->Length() && !found; j++) { found = StringBeginsWith(nsDependentCString(keys[i]), namespaceFilter->ElementAt(j)); } if (!found) continue; } nsCOMPtr uri; if (NS_SUCCEEDED(NS_NewURI(getter_AddRefs(uri), keys[i]))) { rv = AddURI(uri, aType); NS_ENSURE_SUCCESS(rv, rv); } } return NS_OK; } nsresult nsOfflineCacheUpdate::ProcessNextURI() { LOG(("nsOfflineCacheUpdate::ProcessNextURI [%p, current=%d, numItems=%d]", this, mCurrentItem, mItems.Length())); NS_ASSERTION(mState == STATE_DOWNLOADING, "ProcessNextURI should only be called from the DOWNLOADING state"); if (mCurrentItem >= static_cast(mItems.Length())) { if (mPartialUpdate) { return Finish(); } else { // Verify that the manifest wasn't changed during the // update, to prevent capturing a cache while the server // is being updated. The check will call // ManifestCheckCompleted() when it's done. nsRefPtr manifestCheck = new nsManifestCheck(this, mManifestURI, mDocumentURI); if (NS_FAILED(manifestCheck->Begin())) { mSucceeded = PR_FALSE; NotifyError(); return Finish(); } return NS_OK; } } #if defined(PR_LOGGING) if (LOG_ENABLED()) { nsCAutoString spec; mItems[mCurrentItem]->mURI->GetSpec(spec); LOG(("%p: Opening channel for %s", this, spec.get())); } #endif NotifyStarted(mItems[mCurrentItem]); nsresult rv = mItems[mCurrentItem]->OpenChannel(); if (NS_FAILED(rv)) { LoadCompleted(); return rv; } return NS_OK; } nsresult nsOfflineCacheUpdate::GatherObservers(nsCOMArray &aObservers) { for (PRInt32 i = 0; i < mWeakObservers.Count(); i++) { nsCOMPtr observer = do_QueryReferent(mWeakObservers[i]); if (observer) aObservers.AppendObject(observer); else mWeakObservers.RemoveObjectAt(i--); } for (PRInt32 i = 0; i < mObservers.Count(); i++) { aObservers.AppendObject(mObservers[i]); } return NS_OK; } nsresult nsOfflineCacheUpdate::NotifyError() { LOG(("nsOfflineCacheUpdate::NotifyError [%p]", this)); mState = STATE_FINISHED; nsCOMArray observers; nsresult rv = GatherObservers(observers); NS_ENSURE_SUCCESS(rv, rv); for (PRInt32 i = 0; i < observers.Count(); i++) { observers[i]->Error(this); } return NS_OK; } nsresult nsOfflineCacheUpdate::NotifyChecking() { LOG(("nsOfflineCacheUpdate::NotifyChecking [%p]", this)); nsCOMArray observers; nsresult rv = GatherObservers(observers); NS_ENSURE_SUCCESS(rv, rv); for (PRInt32 i = 0; i < observers.Count(); i++) { observers[i]->Checking(this); } return NS_OK; } nsresult nsOfflineCacheUpdate::NotifyNoUpdate() { LOG(("nsOfflineCacheUpdate::NotifyNoUpdate [%p]", this)); mState = STATE_FINISHED; nsCOMArray observers; nsresult rv = GatherObservers(observers); NS_ENSURE_SUCCESS(rv, rv); for (PRInt32 i = 0; i < observers.Count(); i++) { observers[i]->NoUpdate(this); } return NS_OK; } nsresult nsOfflineCacheUpdate::NotifyObsolete() { LOG(("nsOfflineCacheUpdate::NotifyObsolete [%p]", this)); mState = STATE_FINISHED; nsCOMArray observers; nsresult rv = GatherObservers(observers); NS_ENSURE_SUCCESS(rv, rv); for (PRInt32 i = 0; i < observers.Count(); i++) { observers[i]->Obsolete(this); } return NS_OK; } nsresult nsOfflineCacheUpdate::NotifyDownloading() { LOG(("nsOfflineCacheUpdate::NotifyDownloading [%p]", this)); nsCOMArray observers; nsresult rv = GatherObservers(observers); NS_ENSURE_SUCCESS(rv, rv); for (PRInt32 i = 0; i < observers.Count(); i++) { observers[i]->Downloading(this); } return NS_OK; } nsresult nsOfflineCacheUpdate::NotifyStarted(nsOfflineCacheUpdateItem *aItem) { LOG(("nsOfflineCacheUpdate::NotifyStarted [%p, %p]", this, aItem)); nsCOMArray observers; nsresult rv = GatherObservers(observers); NS_ENSURE_SUCCESS(rv, rv); for (PRInt32 i = 0; i < observers.Count(); i++) { observers[i]->ItemStarted(this, aItem); } return NS_OK; } nsresult nsOfflineCacheUpdate::NotifyCompleted(nsOfflineCacheUpdateItem *aItem) { LOG(("nsOfflineCacheUpdate::NotifyCompleted [%p, %p]", this, aItem)); nsCOMArray observers; nsresult rv = GatherObservers(observers); NS_ENSURE_SUCCESS(rv, rv); for (PRInt32 i = 0; i < observers.Count(); i++) { observers[i]->ItemCompleted(this, aItem); } return NS_OK; } void nsOfflineCacheUpdate::AddDocument(nsIDOMDocument *aDocument) { // Add document only if it was not loaded from an offline cache. // If it were loaded from an offline cache then it has already // been associated with it and must not be again cached as // implicit (which are the reasons we collect documents here). nsCOMPtr document = do_QueryInterface(aDocument); if (!document) return; nsIChannel* channel = document->GetChannel(); nsCOMPtr appCacheChannel = do_QueryInterface(channel); if (!appCacheChannel) return; PRBool loadedFromAppCache; appCacheChannel->GetLoadedFromApplicationCache(&loadedFromAppCache); if (loadedFromAppCache) return; mDocuments.AppendObject(aDocument); } void nsOfflineCacheUpdate::SetOwner(nsOfflineCacheUpdateOwner *aOwner) { NS_ASSERTION(!mOwner, "Tried to set cache update owner twice."); mOwner = aOwner; } nsresult nsOfflineCacheUpdate::UpdateFinished(nsOfflineCacheUpdate *aUpdate) { mImplicitUpdate = nsnull; NotifyNoUpdate(); Finish(); return NS_OK; } nsresult nsOfflineCacheUpdate::ScheduleImplicit() { if (mDocuments.Count() == 0) return NS_OK; nsresult rv; nsRefPtr update = new nsOfflineCacheUpdate(); NS_ENSURE_TRUE(update, NS_ERROR_OUT_OF_MEMORY); nsCAutoString clientID; if (mPreviousApplicationCache) { rv = mPreviousApplicationCache->GetClientID(clientID); NS_ENSURE_SUCCESS(rv, rv); } else { clientID = mClientID; } rv = update->InitPartial(mManifestURI, clientID, mDocumentURI); NS_ENSURE_SUCCESS(rv, rv); PRBool added = PR_FALSE; for (PRInt32 i = 0; i < mDocuments.Count(); i++) { nsIDOMDocument* domDoc = mDocuments[i]; nsCOMPtr doc = do_QueryInterface(domDoc); if (!doc) continue; nsIURI* uri = doc->GetDocumentURI(); if (!uri) continue; nsIContent* content = doc->GetRootContent(); nsCOMPtr root = do_QueryInterface(content); if (!root) continue; nsAutoString manifestSpec; rv = root->GetAttribute(NS_LITERAL_STRING("manifest"), manifestSpec); NS_ENSURE_SUCCESS(rv, rv); nsCOMPtr manifestURI; NS_NewURI(getter_AddRefs(manifestURI), manifestSpec, doc->GetDocumentCharacterSet().get(), doc->GetDocumentURI()); if (!manifestURI) continue; rv = update->AddURI(uri, nsIApplicationCache::ITEM_IMPLICIT); NS_ENSURE_SUCCESS(rv, rv); added = PR_TRUE; } if (!added) return NS_OK; update->SetOwner(this); rv = update->Begin(); NS_ENSURE_SUCCESS(rv, rv); mImplicitUpdate = update; return NS_OK; } nsresult nsOfflineCacheUpdate::AssociateDocument(nsIDOMDocument *aDocument) { // Check that the document that requested this update was // previously associated with an application cache. If not, it // should be associated with the new one. nsCOMPtr container = do_QueryInterface(aDocument); if (!container) return NS_OK; nsCOMPtr existingCache; nsresult rv = container->GetApplicationCache(getter_AddRefs(existingCache)); NS_ENSURE_SUCCESS(rv, rv); if (!existingCache) { LOG(("Update %p: associating app cache %s to document %p", this, mClientID.get(), aDocument)); { nsCOMPtr doc = do_QueryInterface(aDocument); nsCAutoString spec; if (doc->GetDocumentURI()) { doc->GetDocumentURI()->GetSpec(spec); } printf("(Bug 471227) Associating app cache %p (%s) to document >%p< (%s)\n", mApplicationCache.get(), mClientID.get(), container.get(), spec.get()); } rv = container->SetApplicationCache(mApplicationCache); NS_ENSURE_SUCCESS(rv, rv); } return NS_OK; } nsresult nsOfflineCacheUpdate::Finish() { LOG(("nsOfflineCacheUpdate::Finish [%p]", this)); // Because the call to UpdateFinished(this) at the end of this method // may relese the last reference to this object but we still want to work // with it after Finish() call ended, make sure to release this instance in // the next thread loop round. NS_ADDREF_THIS(); NS_ProxyRelease(NS_GetCurrentThread(), this, PR_TRUE); mState = STATE_FINISHED; if (!mPartialUpdate) { if (mSucceeded) { nsIArray *namespaces = mManifestItem->GetNamespaces(); nsresult rv = mApplicationCache->AddNamespaces(namespaces); if (NS_FAILED(rv)) { NotifyError(); mSucceeded = PR_FALSE; } rv = mApplicationCache->Activate(); if (NS_FAILED(rv)) { NotifyError(); mSucceeded = PR_FALSE; } for (PRInt32 i = 0; i < mDocuments.Count(); i++) { printf("(Bug 471227) Associating documents from Finish()\n"); AssociateDocument(mDocuments[i]); } } if (mObsolete) { nsCOMPtr appCacheService = do_GetService(NS_APPLICATIONCACHESERVICE_CONTRACTID); if (appCacheService) { nsCAutoString groupID; mApplicationCache->GetGroupID(groupID); appCacheService->DeactivateGroup(groupID); } } if (!mSucceeded) { // Update was not merged, mark all the loads as failures for (PRUint32 i = 0; i < mItems.Length(); i++) { mItems[i]->Cancel(); } mApplicationCache->Discard(); } } nsresult rv = NS_OK; if (mOwner) { rv = mOwner->UpdateFinished(this); mOwner = nsnull; } return rv; } //----------------------------------------------------------------------------- // nsOfflineCacheUpdate::nsIOfflineCacheUpdate //----------------------------------------------------------------------------- NS_IMETHODIMP nsOfflineCacheUpdate::GetUpdateDomain(nsACString &aUpdateDomain) { NS_ENSURE_TRUE(mState >= STATE_INITIALIZED, NS_ERROR_NOT_INITIALIZED); aUpdateDomain = mUpdateDomain; return NS_OK; } NS_IMETHODIMP nsOfflineCacheUpdate::GetStatus(PRUint16 *aStatus) { switch (mState) { case STATE_CHECKING : *aStatus = nsIDOMOfflineResourceList::CHECKING; return NS_OK; case STATE_DOWNLOADING : *aStatus = nsIDOMOfflineResourceList::DOWNLOADING; return NS_OK; default : *aStatus = nsIDOMOfflineResourceList::IDLE; return NS_OK; } return NS_ERROR_FAILURE; } NS_IMETHODIMP nsOfflineCacheUpdate::GetPartial(PRBool *aPartial) { *aPartial = mPartialUpdate; return NS_OK; } NS_IMETHODIMP nsOfflineCacheUpdate::GetManifestURI(nsIURI **aManifestURI) { NS_ENSURE_TRUE(mState >= STATE_INITIALIZED, NS_ERROR_NOT_INITIALIZED); NS_IF_ADDREF(*aManifestURI = mManifestURI); return NS_OK; } NS_IMETHODIMP nsOfflineCacheUpdate::GetSucceeded(PRBool *aSucceeded) { NS_ENSURE_TRUE(mState == STATE_FINISHED, NS_ERROR_NOT_AVAILABLE); *aSucceeded = mSucceeded; return NS_OK; } NS_IMETHODIMP nsOfflineCacheUpdate::GetIsUpgrade(PRBool *aIsUpgrade) { NS_ENSURE_TRUE(mState >= STATE_INITIALIZED, NS_ERROR_NOT_INITIALIZED); *aIsUpgrade = (mPreviousApplicationCache != nsnull); return NS_OK; } nsresult nsOfflineCacheUpdate::AddURI(nsIURI *aURI, PRUint32 aType) { NS_ENSURE_TRUE(mState >= STATE_INITIALIZED, NS_ERROR_NOT_INITIALIZED); if (mState >= STATE_DOWNLOADING) return NS_ERROR_NOT_AVAILABLE; // Resource URIs must have the same scheme as the manifest. nsCAutoString scheme; aURI->GetScheme(scheme); PRBool match; if (NS_FAILED(mManifestURI->SchemeIs(scheme.get(), &match)) || !match) return NS_ERROR_FAILURE; // Don't fetch the same URI twice. for (PRUint32 i = 0; i < mItems.Length(); i++) { PRBool equals; if (NS_SUCCEEDED(mItems[i]->mURI->Equals(aURI, &equals)) && equals) { // retain both types. mItems[i]->mItemType |= aType; return NS_OK; } } nsRefPtr item = new nsOfflineCacheUpdateItem(this, aURI, mDocumentURI, mPreviousApplicationCache, mClientID, aType); if (!item) return NS_ERROR_OUT_OF_MEMORY; mItems.AppendElement(item); mAddedItems = PR_TRUE; return NS_OK; } NS_IMETHODIMP nsOfflineCacheUpdate::AddDynamicURI(nsIURI *aURI) { // If this is a partial update and the resource is already in the // cache, we should only mark the entry, not fetch it again. if (mPartialUpdate) { nsCAutoString key; GetCacheKey(aURI, key); PRUint32 types; nsresult rv = mApplicationCache->GetTypes(key, &types); if (NS_SUCCEEDED(rv)) { if (!(types & nsIApplicationCache::ITEM_DYNAMIC)) { mApplicationCache->MarkEntry (key, nsIApplicationCache::ITEM_DYNAMIC); } return NS_OK; } } return AddURI(aURI, nsIApplicationCache::ITEM_DYNAMIC); } NS_IMETHODIMP nsOfflineCacheUpdate::GetCount(PRUint32 *aNumItems) { LOG(("nsOfflineCacheUpdate::GetNumItems [%p, num=%d]", this, mItems.Length())); NS_ENSURE_TRUE(mState >= STATE_INITIALIZED, NS_ERROR_NOT_INITIALIZED); *aNumItems = mItems.Length(); return NS_OK; } NS_IMETHODIMP nsOfflineCacheUpdate::Item(PRUint32 aIndex, nsIDOMLoadStatus **aItem) { LOG(("nsOfflineCacheUpdate::GetItems [%p, index=%d]", this, aIndex)); NS_ENSURE_TRUE(mState >= STATE_INITIALIZED, NS_ERROR_NOT_INITIALIZED); if (aIndex < mItems.Length()) NS_IF_ADDREF(*aItem = mItems.ElementAt(aIndex)); else *aItem = nsnull; return NS_OK; } NS_IMETHODIMP nsOfflineCacheUpdate::AddObserver(nsIOfflineCacheUpdateObserver *aObserver, PRBool aHoldWeak) { LOG(("nsOfflineCacheUpdate::AddObserver [%p]", this)); NS_ENSURE_TRUE(mState >= STATE_INITIALIZED, NS_ERROR_NOT_INITIALIZED); if (aHoldWeak) { nsCOMPtr weakRef = do_GetWeakReference(aObserver); mWeakObservers.AppendObject(weakRef); } else { mObservers.AppendObject(aObserver); } return NS_OK; } NS_IMETHODIMP nsOfflineCacheUpdate::RemoveObserver(nsIOfflineCacheUpdateObserver *aObserver) { LOG(("nsOfflineCacheUpdate::RemoveObserver [%p]", this)); NS_ENSURE_TRUE(mState >= STATE_INITIALIZED, NS_ERROR_NOT_INITIALIZED); for (PRInt32 i = 0; i < mWeakObservers.Count(); i++) { nsCOMPtr observer = do_QueryReferent(mWeakObservers[i]); if (observer == aObserver) { mWeakObservers.RemoveObjectAt(i); return NS_OK; } } for (PRInt32 i = 0; i < mObservers.Count(); i++) { if (mObservers[i] == aObserver) { mObservers.RemoveObjectAt(i); return NS_OK; } } return NS_OK; } NS_IMETHODIMP nsOfflineCacheUpdate::Schedule() { LOG(("nsOfflineCacheUpdate::Schedule [%p]", this)); nsOfflineCacheUpdateService* service = nsOfflineCacheUpdateService::EnsureService(); if (!service) { return NS_ERROR_FAILURE; } return service->Schedule(this); } //----------------------------------------------------------------------------- // nsOfflineCacheUpdateService::nsISupports //----------------------------------------------------------------------------- NS_IMPL_ISUPPORTS4(nsOfflineCacheUpdateService, nsIOfflineCacheUpdateService, nsIWebProgressListener, nsIObserver, nsISupportsWeakReference) //----------------------------------------------------------------------------- // nsOfflineCacheUpdateService //----------------------------------------------------------------------------- nsOfflineCacheUpdateService::nsOfflineCacheUpdateService() : mDisabled(PR_FALSE) , mUpdateRunning(PR_FALSE) { } nsOfflineCacheUpdateService::~nsOfflineCacheUpdateService() { gOfflineCacheUpdateService = nsnull; } nsresult nsOfflineCacheUpdateService::Init() { nsresult rv; #if defined(PR_LOGGING) if (!gOfflineCacheUpdateLog) gOfflineCacheUpdateLog = PR_NewLogModule("nsOfflineCacheUpdate"); #endif if (!mDocUpdates.Init()) return NS_ERROR_FAILURE; // Observe xpcom-shutdown event nsCOMPtr observerService = do_GetService("@mozilla.org/observer-service;1", &rv); NS_ENSURE_SUCCESS(rv, rv); rv = observerService->AddObserver(this, NS_XPCOM_SHUTDOWN_OBSERVER_ID, PR_TRUE); NS_ENSURE_SUCCESS(rv, rv); // Register as an observer for the document loader nsCOMPtr progress = do_GetService(NS_DOCUMENTLOADER_SERVICE_CONTRACTID); if (progress) { nsresult rv = progress->AddProgressListener (this, nsIWebProgress::NOTIFY_STATE_DOCUMENT); NS_ENSURE_SUCCESS(rv, rv); } gOfflineCacheUpdateService = this; return NS_OK; } /* static */ nsOfflineCacheUpdateService * nsOfflineCacheUpdateService::GetInstance() { if (!gOfflineCacheUpdateService) { gOfflineCacheUpdateService = new nsOfflineCacheUpdateService(); if (!gOfflineCacheUpdateService) return nsnull; NS_ADDREF(gOfflineCacheUpdateService); nsresult rv = gOfflineCacheUpdateService->Init(); if (NS_FAILED(rv)) { NS_RELEASE(gOfflineCacheUpdateService); return nsnull; } return gOfflineCacheUpdateService; } NS_ADDREF(gOfflineCacheUpdateService); return gOfflineCacheUpdateService; } /* static */ nsOfflineCacheUpdateService * nsOfflineCacheUpdateService::EnsureService() { if (!gOfflineCacheUpdateService) { // Make the service manager hold a long-lived reference to the service nsCOMPtr service = do_GetService(NS_OFFLINECACHEUPDATESERVICE_CONTRACTID); } return gOfflineCacheUpdateService; } nsresult nsOfflineCacheUpdateService::Schedule(nsOfflineCacheUpdate *aUpdate) { LOG(("nsOfflineCacheUpdateService::Schedule [%p, update=%p]", this, aUpdate)); aUpdate->SetOwner(this); nsresult rv; nsCOMPtr observerService = do_GetService("@mozilla.org/observer-service;1", &rv); NS_ENSURE_SUCCESS(rv, rv); observerService->NotifyObservers(static_cast(aUpdate), "offline-cache-update-added", nsnull); mUpdates.AppendElement(aUpdate); ProcessNextUpdate(); return NS_OK; } NS_IMETHODIMP nsOfflineCacheUpdateService::ScheduleOnDocumentStop(nsIURI *aManifestURI, nsIURI *aDocumentURI, nsIDOMDocument *aDocument) { LOG(("nsOfflineCacheUpdateService::ScheduleOnDocumentStop [%p, manifestURI=%p, documentURI=%p doc=%p]", this, aManifestURI, aDocumentURI, aDocument)); // Proceed with cache update PendingUpdate *update = new PendingUpdate(); update->mManifestURI = aManifestURI; update->mDocumentURI = aDocumentURI; if (!mDocUpdates.Put(aDocument, update)) return NS_ERROR_FAILURE; return NS_OK; } nsresult nsOfflineCacheUpdateService::UpdateFinished(nsOfflineCacheUpdate *aUpdate) { LOG(("nsOfflineCacheUpdateService::UpdateFinished [%p, update=%p]", this, aUpdate)); NS_ASSERTION(mUpdates.Length() > 0 && mUpdates[0] == aUpdate, "Unknown update completed"); // keep this item alive until we're done notifying observers nsRefPtr update = mUpdates[0]; mUpdates.RemoveElementAt(0); mUpdateRunning = PR_FALSE; nsresult rv; nsCOMPtr observerService = do_GetService("@mozilla.org/observer-service;1", &rv); NS_ENSURE_SUCCESS(rv, rv); observerService->NotifyObservers(static_cast(aUpdate), "offline-cache-update-completed", nsnull); ProcessNextUpdate(); return NS_OK; } //----------------------------------------------------------------------------- // nsOfflineCacheUpdateService //----------------------------------------------------------------------------- nsresult nsOfflineCacheUpdateService::ProcessNextUpdate() { LOG(("nsOfflineCacheUpdateService::ProcessNextUpdate [%p, num=%d]", this, mUpdates.Length())); if (mDisabled) return NS_ERROR_ABORT; if (mUpdateRunning) return NS_OK; if (mUpdates.Length() > 0) { mUpdateRunning = PR_TRUE; return mUpdates[0]->Begin(); } return NS_OK; } //----------------------------------------------------------------------------- // nsOfflineCacheUpdateService::nsIOfflineCacheUpdateService //----------------------------------------------------------------------------- NS_IMETHODIMP nsOfflineCacheUpdateService::GetNumUpdates(PRUint32 *aNumUpdates) { LOG(("nsOfflineCacheUpdateService::GetNumUpdates [%p]", this)); *aNumUpdates = mUpdates.Length(); return NS_OK; } NS_IMETHODIMP nsOfflineCacheUpdateService::GetUpdate(PRUint32 aIndex, nsIOfflineCacheUpdate **aUpdate) { LOG(("nsOfflineCacheUpdateService::GetUpdate [%p, %d]", this, aIndex)); if (aIndex < mUpdates.Length()) { NS_ADDREF(*aUpdate = mUpdates[aIndex]); } else { *aUpdate = nsnull; } return NS_OK; } nsresult nsOfflineCacheUpdateService::Schedule(nsIURI *aManifestURI, nsIURI *aDocumentURI, nsIDOMDocument *aDocument, nsIOfflineCacheUpdate **aUpdate) { // Check for existing updates nsresult rv; for (PRUint32 i = 0; i < mUpdates.Length(); i++) { nsRefPtr update = mUpdates[i]; PRBool partial; rv = update->GetPartial(&partial); NS_ENSURE_SUCCESS(rv, rv); if (partial) { // Partial updates aren't considered continue; } nsCOMPtr manifestURI; update->GetManifestURI(getter_AddRefs(manifestURI)); if (manifestURI) { PRBool equals; rv = manifestURI->Equals(aManifestURI, &equals); if (equals) { if (aDocument) { LOG(("Document %p added to update %p", aDocument, update.get())); update->AddDocument(aDocument); } NS_ADDREF(*aUpdate = update); return NS_OK; } } } // There is no existing update, start one. nsRefPtr update = new nsOfflineCacheUpdate(); if (!update) return NS_ERROR_OUT_OF_MEMORY; rv = update->Init(aManifestURI, aDocumentURI); NS_ENSURE_SUCCESS(rv, rv); if (aDocument) { LOG(("First document %p added to update %p", aDocument, update.get())); update->AddDocument(aDocument); } rv = update->Schedule(); NS_ENSURE_SUCCESS(rv, rv); NS_ADDREF(*aUpdate = update); return NS_OK; } NS_IMETHODIMP nsOfflineCacheUpdateService::ScheduleUpdate(nsIURI *aManifestURI, nsIURI *aDocumentURI, nsIOfflineCacheUpdate **aUpdate) { return Schedule(aManifestURI, aDocumentURI, nsnull, aUpdate); } //----------------------------------------------------------------------------- // nsOfflineCacheUpdateService::nsIObserver //----------------------------------------------------------------------------- NS_IMETHODIMP nsOfflineCacheUpdateService::Observe(nsISupports *aSubject, const char *aTopic, const PRUnichar *aData) { if (!strcmp(aTopic, NS_XPCOM_SHUTDOWN_OBSERVER_ID)) { if (mUpdates.Length() > 0) mUpdates[0]->Cancel(); mDisabled = PR_TRUE; } return NS_OK; } //----------------------------------------------------------------------------- // nsOfflineCacheUpdateService::nsIWebProgressListener //----------------------------------------------------------------------------- NS_IMETHODIMP nsOfflineCacheUpdateService::OnProgressChange(nsIWebProgress *aProgress, nsIRequest *aRequest, PRInt32 curSelfProgress, PRInt32 maxSelfProgress, PRInt32 curTotalProgress, PRInt32 maxTotalProgress) { NS_NOTREACHED("notification excluded in AddProgressListener(...)"); return NS_OK; } NS_IMETHODIMP nsOfflineCacheUpdateService::OnStateChange(nsIWebProgress* aWebProgress, nsIRequest *aRequest, PRUint32 progressStateFlags, nsresult aStatus) { if ((progressStateFlags & STATE_IS_DOCUMENT) && (progressStateFlags & STATE_STOP)) { if (mDocUpdates.Count() == 0) return NS_OK; nsCOMPtr window; aWebProgress->GetDOMWindow(getter_AddRefs(window)); if (!window) return NS_OK; nsCOMPtr doc; window->GetDocument(getter_AddRefs(doc)); if (!doc) return NS_OK; LOG(("nsOfflineCacheUpdateService::OnStateChange [%p, doc=%p]", this, doc.get())); PendingUpdate *pendingUpdate; if (mDocUpdates.Get(doc, &pendingUpdate)) { // Only schedule the update if the document loaded successfully if (NS_SUCCEEDED(aStatus)) { nsCOMPtr update; Schedule(pendingUpdate->mManifestURI, pendingUpdate->mDocumentURI, doc, getter_AddRefs(update)); } mDocUpdates.Remove(doc); } return NS_OK; } return NS_OK; } NS_IMETHODIMP nsOfflineCacheUpdateService::OnLocationChange(nsIWebProgress* aWebProgress, nsIRequest* aRequest, nsIURI *location) { NS_NOTREACHED("notification excluded in AddProgressListener(...)"); return NS_OK; } NS_IMETHODIMP nsOfflineCacheUpdateService::OnStatusChange(nsIWebProgress* aWebProgress, nsIRequest* aRequest, nsresult aStatus, const PRUnichar* aMessage) { NS_NOTREACHED("notification excluded in AddProgressListener(...)"); return NS_OK; } NS_IMETHODIMP nsOfflineCacheUpdateService::OnSecurityChange(nsIWebProgress *aWebProgress, nsIRequest *aRequest, PRUint32 state) { NS_NOTREACHED("notification excluded in AddProgressListener(...)"); return NS_OK; } NS_IMETHODIMP nsOfflineCacheUpdateService::OfflineAppAllowed(nsIPrincipal *aPrincipal, nsIPrefBranch *aPrefBranch, PRBool *aAllowed) { nsCOMPtr codebaseURI; nsresult rv = aPrincipal->GetURI(getter_AddRefs(codebaseURI)); NS_ENSURE_SUCCESS(rv, rv); return OfflineAppAllowedForURI(codebaseURI, aPrefBranch, aAllowed); } NS_IMETHODIMP nsOfflineCacheUpdateService::OfflineAppAllowedForURI(nsIURI *aURI, nsIPrefBranch *aPrefBranch, PRBool *aAllowed) { *aAllowed = PR_FALSE; nsCOMPtr innerURI = NS_GetInnermostURI(aURI); if (!innerURI) return NS_OK; // only http and https applications can use offline APIs. PRBool match; nsresult rv = innerURI->SchemeIs("http", &match); NS_ENSURE_SUCCESS(rv, rv); if (!match) { rv = innerURI->SchemeIs("https", &match); NS_ENSURE_SUCCESS(rv, rv); if (!match) { return NS_OK; } } nsCOMPtr permissionManager = do_GetService(NS_PERMISSIONMANAGER_CONTRACTID); if (!permissionManager) { return NS_OK; } PRUint32 perm; permissionManager->TestExactPermission(innerURI, "offline-app", &perm); if (perm == nsIPermissionManager::UNKNOWN_ACTION) { nsCOMPtr branch = aPrefBranch; if (!branch) { branch = do_GetService(NS_PREFSERVICE_CONTRACTID); } if (branch) { rv = branch->GetBoolPref("offline-apps.allow_by_default", aAllowed); if (NS_FAILED(rv)) { *aAllowed = PR_FALSE; } } return NS_OK; } if (perm == nsIPermissionManager::DENY_ACTION) { return NS_OK; } *aAllowed = PR_TRUE; return NS_OK; }