/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ /* This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ #include "nsAboutCache.h" #include "nsIInputStream.h" #include "nsIStorageStream.h" #include "nsIURI.h" #include "nsCOMPtr.h" #include "nsNetUtil.h" #include "nsIPipe.h" #include "nsContentUtils.h" #include "nsEscape.h" #include "nsAboutProtocolUtils.h" #include "nsPrintfCString.h" #include "nsDOMString.h" #include "nsICacheStorageService.h" #include "nsICacheStorage.h" #include "CacheFileUtils.h" #include "CacheObserver.h" #include "nsThreadUtils.h" using namespace mozilla::net; NS_IMPL_ISUPPORTS(nsAboutCache, nsIAboutModule, nsICacheStorageVisitor) NS_IMETHODIMP nsAboutCache::NewChannel(nsIURI* aURI, nsILoadInfo* aLoadInfo, nsIChannel** result) { NS_ENSURE_ARG_POINTER(aURI); nsresult rv; *result = nullptr; nsCOMPtr inputStream; rv = NS_NewPipe(getter_AddRefs(inputStream), getter_AddRefs(mStream), 16384, (uint32_t)-1, true, // non-blocking input false // blocking output ); if (NS_FAILED(rv)) return rv; nsAutoCString storageName; rv = ParseURI(aURI, storageName); if (NS_FAILED(rv)) return rv; mOverview = storageName.IsEmpty(); if (mOverview) { // ...and visit all we can mStorageList.AppendElement(NS_LITERAL_CSTRING("memory")); mStorageList.AppendElement(NS_LITERAL_CSTRING("disk")); mStorageList.AppendElement(NS_LITERAL_CSTRING("appcache")); } else { // ...and visit just the specified storage, entries will output too mStorageList.AppendElement(storageName); } // The entries header is added on encounter of the first entry mEntriesHeaderAdded = false; nsCOMPtr channel; rv = NS_NewInputStreamChannelInternal(getter_AddRefs(channel), aURI, inputStream, NS_LITERAL_CSTRING("text/html"), NS_LITERAL_CSTRING("utf-8"), aLoadInfo); if (NS_FAILED(rv)) return rv; mBuffer.AssignLiteral( "\n" "\n" "\n" " Network Cache Storage Information\n" " \n" " \n" " \n" " " "\n" "\n" "

Information about the Network Cache Storage Service

\n"); // Add the context switch controls mBuffer.AppendLiteral( " Private\n" " Anonymous\n" ); if (CacheObserver::UseNewCache()) { // Visit scoping by browser and appid is not implemented for // the old cache, simply don't add these controls. // The appid/inbrowser entries are already mixed in the default // view anyway. mBuffer.AppendLiteral( " AppID\n" " In Browser Element\n" ); } mBuffer.AppendLiteral( "\n" ); if (!mOverview) { mBuffer.AppendLiteral("Back to overview"); } FlushBuffer(); // Kick it, this goes async. rv = VisitNextStorage(); if (NS_FAILED(rv)) return rv; channel.forget(result); return NS_OK; } nsresult nsAboutCache::ParseURI(nsIURI * uri, nsACString & storage) { // // about:cache[?storage=[&context=]] // nsresult rv; nsAutoCString path; rv = uri->GetPath(path); if (NS_FAILED(rv)) return rv; mContextString.Truncate(); mLoadInfo = CacheFileUtils::ParseKey(NS_LITERAL_CSTRING("")); storage.Truncate(); nsACString::const_iterator start, valueStart, end; path.BeginReading(start); path.EndReading(end); valueStart = end; if (!FindInReadable(NS_LITERAL_CSTRING("?storage="), start, valueStart)) { return NS_OK; } nsACString::const_iterator storageNameBegin = valueStart; start = valueStart; valueStart = end; if (!FindInReadable(NS_LITERAL_CSTRING("&context="), start, valueStart)) start = end; nsACString::const_iterator storageNameEnd = start; mContextString = Substring(valueStart, end); mLoadInfo = CacheFileUtils::ParseKey(mContextString); storage.Assign(Substring(storageNameBegin, storageNameEnd)); return NS_OK; } nsresult nsAboutCache::VisitNextStorage() { if (!mStorageList.Length()) return NS_ERROR_NOT_AVAILABLE; mStorageName = mStorageList[0]; mStorageList.RemoveElementAt(0); // Must re-dispatch since we cannot start another visit cycle // from visitor callback. The cache v1 service doesn't like it. // TODO - mayhemer, bug 913828, remove this dispatch and call // directly. nsCOMPtr event = NS_NewRunnableMethod(this, &nsAboutCache::FireVisitStorage); return NS_DispatchToMainThread(event); } void nsAboutCache::FireVisitStorage() { nsresult rv; rv = VisitStorage(mStorageName); if (NS_FAILED(rv)) { if (mLoadInfo) { char* escaped = nsEscapeHTML(mStorageName.get()); mBuffer.Append( nsPrintfCString("

Unrecognized storage name '%s' in about:cache URL

", escaped)); free(escaped); } else { char* escaped = nsEscapeHTML(mContextString.get()); mBuffer.Append( nsPrintfCString("

Unrecognized context key '%s' in about:cache URL

", escaped)); free(escaped); } FlushBuffer(); // Simulate finish of a visit cycle, this tries the next storage // or closes the output stream (i.e. the UI loader will stop spinning) OnCacheEntryVisitCompleted(); } } nsresult nsAboutCache::VisitStorage(nsACString const & storageName) { nsresult rv; rv = GetStorage(storageName, mLoadInfo, getter_AddRefs(mStorage)); if (NS_FAILED(rv)) return rv; rv = mStorage->AsyncVisitStorage(this, !mOverview); if (NS_FAILED(rv)) return rv; return NS_OK; } //static nsresult nsAboutCache::GetStorage(nsACString const & storageName, nsILoadContextInfo* loadInfo, nsICacheStorage **storage) { nsresult rv; nsCOMPtr cacheService = do_GetService("@mozilla.org/netwerk/cache-storage-service;1", &rv); if (NS_FAILED(rv)) return rv; nsCOMPtr cacheStorage; if (storageName == "disk") { rv = cacheService->DiskCacheStorage( loadInfo, false, getter_AddRefs(cacheStorage)); } else if (storageName == "memory") { rv = cacheService->MemoryCacheStorage( loadInfo, getter_AddRefs(cacheStorage)); } else if (storageName == "appcache") { rv = cacheService->AppCacheStorage( loadInfo, nullptr, getter_AddRefs(cacheStorage)); } else { rv = NS_ERROR_UNEXPECTED; } if (NS_FAILED(rv)) return rv; cacheStorage.forget(storage); return NS_OK; } NS_IMETHODIMP nsAboutCache::OnCacheStorageInfo(uint32_t aEntryCount, uint64_t aConsumption, uint64_t aCapacity, nsIFile * aDirectory) { // We need mStream for this if (!mStream) { return NS_ERROR_FAILURE; } mBuffer.AssignLiteral("

"); mBuffer.Append(mStorageName); mBuffer.AppendLiteral("

\n" "\n"); // Write out cache info // Number of entries mBuffer.AppendLiteral(" \n" " \n" " \n" " \n"); // Maximum storage size mBuffer.AppendLiteral(" \n" " \n" " \n" " \n"); // Storage in use mBuffer.AppendLiteral(" \n" " \n" " \n" " \n"); // Storage disk location mBuffer.AppendLiteral(" \n" " \n" " \n" " \n"); if (mOverview) { // The about:cache case if (aEntryCount != 0) { // Add the "List Cache Entries" link mBuffer.AppendLiteral(" \n" " \n" " \n"); } } mBuffer.AppendLiteral("

List Cache Entries
Number of entries:	"); mBuffer.AppendInt(aEntryCount); mBuffer.AppendLiteral("
Maximum storage size:	"); mBuffer.AppendInt(aCapacity / 1024); mBuffer.AppendLiteral(" KiB
Storage in use:	"); mBuffer.AppendInt(aConsumption / 1024); mBuffer.AppendLiteral(" KiB
Storage disk location:	"); if (aDirectory) { nsAutoString path; aDirectory->GetPath(path); mBuffer.Append(NS_ConvertUTF16toUTF8(path)); } else { mBuffer.AppendLiteral("none, only stored in memory"); } mBuffer.AppendLiteral("

\n"); // The entries header is added on encounter of the first entry mEntriesHeaderAdded = false; FlushBuffer(); if (mOverview) { // OnCacheEntryVisitCompleted() is not called when we do not iterate // cache entries. Since this moves forward to the next storage in // the list we want to visit, artificially call it here. OnCacheEntryVisitCompleted(); } return NS_OK; } NS_IMETHODIMP nsAboutCache::OnCacheEntryInfo(nsIURI *aURI, const nsACString & aIdEnhance, int64_t aDataSize, int32_t aFetchCount, uint32_t aLastModified, uint32_t aExpirationTime, bool aPinned) { // We need mStream for this if (!mStream) { return NS_ERROR_FAILURE; } if (!mEntriesHeaderAdded) { mBuffer.AppendLiteral("

\n" "\n" " \n" " \n" " \n" " \n" " \n" " \n" " \n" " \n" " \n" " \n" " \n" " \n" " \n" " \n" " \n" " \n" " \n" " \n"); mEntriesHeaderAdded = true; } // Generate a about:cache-entry URL for this entry... nsAutoCString url; url.AssignLiteral("about:cache-entry?storage="); url.Append(mStorageName); url.AppendLiteral("&context="); char* escapedContext = nsEscapeHTML(mContextString.get()); url += escapedContext; free(escapedContext); url.AppendLiteral("&eid="); char* escapedEID = nsEscapeHTML(aIdEnhance.BeginReading()); url += escapedEID; free(escapedEID); nsAutoCString cacheUriSpec; aURI->GetAsciiSpec(cacheUriSpec); char* escapedCacheURI = nsEscapeHTML(cacheUriSpec.get()); url.AppendLiteral("&uri="); url += escapedCacheURI; // Entry start... mBuffer.AppendLiteral(" \n"); // URI mBuffer.AppendLiteral(" \n"); free(escapedCacheURI); // Content length mBuffer.AppendLiteral(" \n"); // Number of accesses mBuffer.AppendLiteral(" \n"); // vars for reporting time char buf[255]; // Last modified time mBuffer.AppendLiteral(" \n"); // Expires time mBuffer.AppendLiteral(" \n"); // Pinning mBuffer.AppendLiteral(" \n"); // Entry is done... mBuffer.AppendLiteral(" \n"); FlushBuffer(); return NS_OK; } NS_IMETHODIMP nsAboutCache::OnCacheEntryVisitCompleted() { if (!mStream) { return NS_ERROR_FAILURE; } if (mEntriesHeaderAdded) { mBuffer.AppendLiteral("

Key	Data size	Fetch count	Last Modifed	Expires	Pinning
"); if (!aIdEnhance.IsEmpty()) { mBuffer.Append(aIdEnhance); mBuffer.Append(':'); } mBuffer.Append(escapedCacheURI); mBuffer.AppendLiteral("	"); mBuffer.AppendInt(aDataSize); mBuffer.AppendLiteral(" bytes	"); mBuffer.AppendInt(aFetchCount); mBuffer.AppendLiteral("	"); if (aLastModified) { PrintTimeString(buf, sizeof(buf), aLastModified); mBuffer.Append(buf); } else { mBuffer.AppendLiteral("No last modified time (bug 1000338)"); } mBuffer.AppendLiteral("	"); if (aExpirationTime < 0xFFFFFFFF) { PrintTimeString(buf, sizeof(buf), aExpirationTime); mBuffer.Append(buf); } else { mBuffer.AppendLiteral("No expiration time"); } mBuffer.AppendLiteral("	"); if (aPinned) { mBuffer.Append(NS_LITERAL_CSTRING("Pinned")); } else { mBuffer.Append(NS_LITERAL_CSTRING(" ")); } mBuffer.AppendLiteral("

\n"); } // Kick another storage visiting (from a storage that allows us.) while (mStorageList.Length()) { nsresult rv = VisitNextStorage(); if (NS_SUCCEEDED(rv)) { // Expecting new round of OnCache* calls. return NS_OK; } } // We are done! mBuffer.AppendLiteral("\n" "\n"); FlushBuffer(); mStream->Close(); return NS_OK; } void nsAboutCache::FlushBuffer() { uint32_t bytesWritten; mStream->Write(mBuffer.get(), mBuffer.Length(), &bytesWritten); mBuffer.Truncate(); } NS_IMETHODIMP nsAboutCache::GetURIFlags(nsIURI *aURI, uint32_t *result) { *result = 0; return NS_OK; } NS_IMETHODIMP nsAboutCache::GetIndexedDBOriginPostfix(nsIURI *aURI, nsAString &result) { SetDOMStringToNull(result); return NS_ERROR_NOT_IMPLEMENTED; } // static nsresult nsAboutCache::Create(nsISupports *aOuter, REFNSIID aIID, void **aResult) { nsAboutCache* about = new nsAboutCache(); if (about == nullptr) return NS_ERROR_OUT_OF_MEMORY; NS_ADDREF(about); nsresult rv = about->QueryInterface(aIID, aResult); NS_RELEASE(about); return rv; } ////////////////////////////////////////////////////////////////////////////////