Magic-Mirror/gecko-dev
1
0
Fork 0
mirror of https://github.com/mozilla/gecko-dev.git synced 2024-11-26 06:11:37 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add cache key, referrer and extra headers parameters to nsIWebBrowserPersist::saveURI b=170722 r=bzbarsky@mit.edu sr=darin@netscape.com

Browse Source
This commit is contained in:
locka%iol.ie 2003-01-08 23:53:10 +00:00
parent b9083989bb
commit 4514a26c79
12 changed files with 138 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docshell/base/nsDocShell.cpp
View File

@ -5455,6 +5455,7 @@ nsDocShell::AddHeadersToChannel(nsIInputStream * aHeadersData,
// add the value as a header to the nsIHttpChannel
//
const char *kWhitespace = "\b\t\r\n ";
while (PR_TRUE) {
crlf = headersString.Find("\r\n", PR_TRUE);
if (-1 == crlf) {
@ -5462,7 +5463,6 @@ nsDocShell::AddHeadersToChannel(nsIInputStream * aHeadersData,
}
headersString.Mid(oneHeader, 0, crlf);
headersString.Cut(0, crlf + 2);
oneHeader.StripWhitespace();
colon = oneHeader.Find(":");
if (-1 == colon) {
return NS_ERROR_NULL_POINTER;
@ -5470,6 +5470,8 @@ nsDocShell::AddHeadersToChannel(nsIInputStream * aHeadersData,
oneHeader.Left(headerName, colon);
colon++;
oneHeader.Mid(headerValue, colon, oneHeader.Length() - colon);
headerName.Trim(kWhitespace);
headerValue.Trim(kWhitespace);
//
// FINALLY: we can set the header!

2
embedding/browser/photon/src/EmbedWindow.cpp
View File

@ -204,7 +204,7 @@ EmbedWindow::SaveURI(nsIURI *uri, char *fname)
nsCOMPtr<nsILocalFile> file;
NS_NewNativeLocalFile(nsDependentCString(fname), PR_TRUE, getter_AddRefs(file));
persist->SetProgressListener((nsIWebProgressListener*) w->EmbedRef->mProgress);
persist->SaveURI(uri, nsnull, file);
persist->SaveURI(uri, nsnull, nsnull, nsnull, nsnull, file);
return (0);
}
return 1;

2
embedding/browser/powerplant/source/CBrowserShell.cpp
View File

@ -1220,7 +1220,7 @@ NS_METHOD CBrowserShell::SaveInternal(nsIURI* inURI, nsIDOMDocument* inDocument,
webPersist->SetProgressListener(sniffer); // owned
return webPersist->SaveURI(inURI, nsnull, tmpFile);
return webPersist->SaveURI(inURI, nsnull, nsnull, nsnull, nsnull, tmpFile);
}

2
embedding/browser/powerplant/source/CHeaderSniffer.cpp
View File

@ -404,7 +404,7 @@ nsresult CHeaderSniffer::InitiateDownload(nsISupports* inSourceData, nsILocalFil
if (sourceURI)
{
rv = webPersist->SaveURI(sourceURI, mPostData, inDestFile);
rv = webPersist->SaveURI(sourceURI, nsnull, nsnull, mPostData, nsnull, inDestFile);
}
else
{

10
embedding/browser/webBrowser/nsWebBrowser.cpp
View File

@ -890,8 +890,12 @@ NS_IMETHODIMP nsWebBrowser::SetProgressListener(nsIWebProgressListener * aProgre
return NS_OK;
}
/* void saveURI (in nsIURI aURI, in nsISupports aFile); */
NS_IMETHODIMP nsWebBrowser::SaveURI(nsIURI *aURI, nsIInputStream *aPostData, nsISupports *aFile)
/* void saveURI (in nsIURI aURI, in nsIURI aReferrer,
in nsISupports aCacheKey, in nsIInputStream aPostData, in wstring aExtraHeaders,
in nsISupports aFile); */
NS_IMETHODIMP nsWebBrowser::SaveURI(
nsIURI *aURI, nsISupports *aCacheKey, nsIURI *aReferrer, nsIInputStream *aPostData,
const char *aExtraHeaders, nsISupports *aFile)
{
if (mPersist)
{
@ -929,7 +933,7 @@ NS_IMETHODIMP nsWebBrowser::SaveURI(nsIURI *aURI, nsIInputStream *aPostData, nsI
mPersist->SetProgressListener(this);
mPersist->SetPersistFlags(mPersistFlags);
mPersist->GetCurrentState(&mPersistCurrentState);
rv = mPersist->SaveURI(uri, aPostData, aFile);
rv = mPersist->SaveURI(uri, aCacheKey, aReferrer, aPostData, aExtraHeaders, aFile);
if (NS_FAILED(rv))
{
mPersist = nsnull;

2
embedding/components/ui/progressDlg/nsProgressDlg.js
View File

@ -394,7 +394,7 @@ function onLoad() {
try {
var uri = persistArgs.source.QueryInterface(Components.interfaces.nsIURI);
webBrowserPersist.saveURI(uri, persistArgs.postData, targetFile);
webBrowserPersist.saveURI(uri, null, null, persistArgs.postData, null, targetFile);
}
catch (e) {
// Saving a Document, not a URI:

30
embedding/components/webbrowserpersist/public/nsIWebBrowserPersist.idl
View File

@ -33,7 +33,7 @@ interface nsILocalFile;
*/
/**
* Interface for persisting DOM documents and URIs to local storage.
* Interface for persisting DOM documents and URIs to local or remote storage.
*/
[scriptable, uuid(814ba433-a816-4785-9f95-ad3ba0a43dab)]
interface nsIWebBrowserPersist : nsISupports
@ -63,7 +63,11 @@ interface nsIWebBrowserPersist : nsISupports
/** Force serialization of output (one file at a time; not concurrent) */
const unsigned long PERSIST_FLAGS_SERIALIZE_OUTPUT = 1024;
/** Flags governing how data is fetched from the network. */
/**
* Flags governing how data is fetched and saved from the network.
* It is best to set this value explicitly unless you are prepared
* to accept the default values.
*/
attribute unsigned long persistFlags;
/** Persister is ready to save data */
@ -105,17 +109,28 @@ interface nsIWebBrowserPersist : nsISupports
* @param aURI URI to save to file. Some implementations of this interface
* may also support <CODE>nsnull</CODE> to imply the currently
* loaded URI.
* @param aPostData Data to pass with in an HTTP request or nsnull.
* @param aFile Target local file. This may be a nsILocalFile object or an
* nsIURI object with a file scheme.
* @param aCacheKey An object representing the URI in the cache or
* <CODE>nsnull</CODE>.
* @param aReferrer The referrer URI to pass with an HTTP request or
* <CODE>nsnull</CODE>.
* @param aPostData Post data to pass with an HTTP request or
* <CODE>nsnull</CODE>.
* @param aExtraHeaders Additional headers to supply with an HTTP request
* or <CODE>nsnull</CODE>.
* @param aFile Target file. This may be a nsILocalFile object or an
* nsIURI object with a file scheme or a scheme that
* supports uploading (e.g. ftp).
*
* @see nsILocalFile
* @see nsIURI
* @see nsIInputStream
*
* @return NS_OK Operation has been started.
* @return NS_ERROR_INVALID_ARG One or more arguments was invalid.
*/
void saveURI(in nsIURI aURI, in nsIInputStream aPostData, in nsISupports aFile);
void saveURI(in nsIURI aURI, in nsISupports aCacheKey,
in nsIURI aReferrer, in nsIInputStream aPostData,
in string aExtraHeaders, in nsISupports aFile);
/** Output only the current selection as opposed to the whole document. */
const unsigned long ENCODE_FLAGS_SELECTION_ONLY = 1;
@ -197,7 +212,8 @@ interface nsIWebBrowserPersist : nsISupports
* this interface may also support <CODE>nsnull</CODE>
* to imply the currently loaded document.
* @param aFile Target local file. This may be a nsILocalFile object or an
* nsIURI object with a file scheme.
* nsIURI object with a file scheme or a scheme that
* supports uploading (e.g. ftp).
* @param aDataPath Path to directory where URIs linked to the document
* are saved or nsnull if no linked URIs should be saved.
* This may be a nsILocalFile object or an nsIURI object

2
embedding/components/webbrowserpersist/src/Makefile.in
View File

@ -38,6 +38,8 @@ REQUIRES = xpcom \
mimetype \
intl \
unicharutil \
docshell \
shistory \
$(NULL)
CPPSRCS = nsWebBrowserPersist.cpp \

103
embedding/components/webbrowserpersist/src/nsWebBrowserPersist.cpp
View File

@ -40,6 +40,7 @@
#include "nsIHttpChannel.h"
#include "nsIEncodedChannel.h"
#include "nsIUploadChannel.h"
#include "nsICachingChannel.h"
#include "nsEscape.h"
#include "nsUnicharUtils.h"
#include "nsCRT.h"
@ -61,6 +62,8 @@
#include "nsIWebProgressListener.h"
#include "nsIAuthPrompt.h"
#include "nsIPrompt.h"
#include "nsISHEntry.h"
#include "nsIWebPageDescriptor.h"
#include "nsIDOMNodeFilter.h"
#include "nsIDOMProcessingInstruction.h"
@ -336,9 +339,11 @@ NS_IMETHODIMP nsWebBrowserPersist::SetProgressListener(
return NS_OK;
}
/* void saveURI (in nsIURI aURI, in string aFileName); */
/* void saveURI (in nsIURI aURI, in nsIURI aReferrer,
in nsIInputStream aPostData, in wstring aExtraHeaders,
in nsISupports aFile); */
NS_IMETHODIMP nsWebBrowserPersist::SaveURI(
nsIURI *aURI, nsIInputStream *aPostData, nsISupports *aFile)
nsIURI *aURI, nsISupports *aCacheKey, nsIURI *aReferrer, nsIInputStream *aPostData, const char *aExtraHeaders, nsISupports *aFile)
{
NS_ENSURE_TRUE(mFirstAndOnlyUse, NS_ERROR_FAILURE);
mFirstAndOnlyUse = PR_FALSE; // Stop people from reusing this object!
@ -348,10 +353,9 @@ NS_IMETHODIMP nsWebBrowserPersist::SaveURI(
rv = GetValidURIFromObject(aFile, getter_AddRefs(fileAsURI));
NS_ENSURE_SUCCESS(rv, NS_ERROR_INVALID_ARG);
return SaveURIInternal(aURI, aPostData, fileAsURI, PR_FALSE);
return SaveURIInternal(aURI, aCacheKey, aReferrer, aPostData, aExtraHeaders, fileAsURI, PR_FALSE);
}
/* void saveDocument (in nsIDOMDocument aDocument, in nsIURI aFileURI,
in nsIURI aDataPathURI, in string aOutputContentType,
in unsigned long aEncodingFlags, in unsigned long aWrapColumn); */
@ -1070,7 +1074,9 @@ nsresult nsWebBrowserPersist::AppendPathToURI(nsIURI *aURI, const nsAString & aP
}
nsresult nsWebBrowserPersist::SaveURIInternal(
nsIURI *aURI, nsIInputStream *aPostData, nsIURI *aFile, PRBool aCalcFileExt)
nsIURI *aURI, nsISupports *aCacheKey, nsIURI *aReferrer,
nsIInputStream *aPostData, const char *aExtraHeaders,
nsIURI *aFile, PRBool aCalcFileExt)
{
NS_ENSURE_ARG_POINTER(aURI);
NS_ENSURE_ARG_POINTER(aFile);
@ -1089,6 +1095,34 @@ nsresult nsWebBrowserPersist::SaveURIInternal(
loadFlags |= nsIRequest::LOAD_FROM_CACHE;
}
// Extract the cache key
nsCOMPtr<nsISupports> cacheKey;
if (aCacheKey)
{
// Test if the cache key is actually a web page descriptor (docshell)
nsCOMPtr<nsIWebPageDescriptor> webPageDescriptor = do_QueryInterface(aCacheKey);
if (webPageDescriptor)
{
nsCOMPtr<nsISupports> currentDescriptor;
webPageDescriptor->GetCurrentDescriptor(getter_AddRefs(currentDescriptor));
if (currentDescriptor)
{
// Descriptor is actually a session history entry
nsCOMPtr<nsISHEntry> shEntry = do_QueryInterface(currentDescriptor);
NS_ASSERTION(shEntry, "The descriptor is meant to be a session history entry");
if (shEntry)
{
shEntry->GetCacheKey(getter_AddRefs(cacheKey));
}
}
}
else
{
// Assume a plain cache key
cacheKey = aCacheKey;
}
}
// Open a channel to the URI
nsCOMPtr<nsIChannel> inputChannel;
rv = NS_NewChannel(getter_AddRefs(inputChannel), aURI,
@ -1111,11 +1145,18 @@ nsresult nsWebBrowserPersist::SaveURIInternal(
}
}
// Post data
if (aPostData)
// Set the referrer, post data and headers if any
nsCOMPtr<nsIHttpChannel> httpChannel(do_QueryInterface(inputChannel));
if (httpChannel)
{
nsCOMPtr<nsIHttpChannel> httpChannel(do_QueryInterface(inputChannel));
if (httpChannel)
// Referrer
if (aReferrer)
{
httpChannel->SetReferrer(aReferrer);
}
// Post data
if (aPostData)
{
nsCOMPtr<nsISeekableStream> stream(do_QueryInterface(aPostData));
if (stream)
@ -1128,6 +1169,48 @@ nsresult nsWebBrowserPersist::SaveURIInternal(
uploadChannel->SetUploadStream(aPostData, NS_LITERAL_CSTRING(""), -1);
}
}
// Cache key
nsCOMPtr<nsICachingChannel> cacheChannel(do_QueryInterface(httpChannel));
if (cacheChannel && cacheKey)
{
cacheChannel->SetCacheKey(cacheKey);
}
// Headers
if (aExtraHeaders)
{
nsCAutoString oneHeader;
nsCAutoString headerName;
nsCAutoString headerValue;
PRInt32 crlf = 0;
PRInt32 colon = 0;
const char *kWhitespace = "\b\t\r\n ";
nsCAutoString extraHeaders(aExtraHeaders);
while (PR_TRUE)
{
crlf = extraHeaders.Find("\r\n", PR_TRUE);
if (crlf == -1)
break;
extraHeaders.Mid(oneHeader, 0, crlf);
extraHeaders.Cut(0, crlf + 2);
colon = oneHeader.Find(":");
if (colon == -1)
break; // Should have a colon
oneHeader.Left(headerName, colon);
colon++;
oneHeader.Mid(headerValue, colon, oneHeader.Length() - colon);
headerName.Trim(kWhitespace);
headerValue.Trim(kWhitespace);
// Add the header (merging if required)
rv = httpChannel->SetRequestHeader(headerName, headerValue, PR_TRUE);
if (NS_FAILED(rv))
{
EndDownload(NS_ERROR_FAILURE);
return NS_ERROR_FAILURE;
}
}
}
}
// Add the output transport to the output map with the channel as the key
@ -2117,7 +2200,7 @@ nsWebBrowserPersist::EnumPersistURIs(nsHashKey *aKey, void *aData, void* closure
rv = pthis->AppendPathToURI(fileAsURI, data->mFilename);
NS_ENSURE_SUCCESS(rv, PR_FALSE);
rv = pthis->SaveURIInternal(uri, nsnull, fileAsURI, PR_TRUE);
rv = pthis->SaveURIInternal(uri, nsnull, nsnull, nsnull, nsnull, fileAsURI, PR_TRUE);
// Store the actual object because once it's persisted this
// will be fixed up with the right file extension.

3
embedding/components/webbrowserpersist/src/nsWebBrowserPersist.h
View File

@ -74,7 +74,8 @@ protected:
nsresult CloneNodeWithFixedUpURIAttributes(
nsIDOMNode *aNodeIn, nsIDOMNode **aNodeOut);
nsresult SaveURIInternal(
nsIURI *aURI, nsIInputStream *aPostData, nsIURI *aFile,
nsIURI *aURI, nsISupports *aCacheKey, nsIURI *aReferrer,
nsIInputStream *aPostData, const char *aExtraHeaders, nsIURI *aFile,
PRBool aCalcFileExt);
nsresult SaveDocumentInternal(
nsIDOMDocument *aDocument, nsIURI *aFile, nsIURI *aDataPath);

6
embedding/tests/mfcembed/BrowserView.cpp
View File

@ -690,7 +690,7 @@ void CBrowserView::OnFileSaveAs()
if(bSaveAll)
persist->SaveDocument(nsnull, file, dataPath, nsnull, 0, 0);
else
persist->SaveURI(nsnull, nsnull, file);
persist->SaveURI(nsnull, nsnull, nsnull, nsnull, nsnull, file);
}
}
}
@ -826,7 +826,7 @@ void CBrowserView::OnSaveLinkAs()
{
nsCOMPtr<nsILocalFile> file;
NS_NewNativeLocalFile(nsDependentCString(strFullPath.GetBuffer(0)), TRUE, getter_AddRefs(file));
persist->SaveURI(linkURI, nsnull, file);
persist->SaveURI(linkURI, nsnull, nsnull, nsnull, nsnull, file);
}
}
}
@ -872,7 +872,7 @@ void CBrowserView::OnSaveImageAs()
{
nsCOMPtr<nsILocalFile> file;
NS_NewNativeLocalFile(nsDependentCString(strFullPath.GetBuffer(0)), TRUE, getter_AddRefs(file));
persist->SaveURI(linkURI, nsnull, file);
persist->SaveURI(linkURI, nsnull, nsnull, nsnull, nsnull, file);
}
}
}

2
xpfe/communicator/resources/content/contentAreaUtils.js
View File

@ -371,7 +371,7 @@ function foundHeaderInfo(aSniffer, aData)
persistArgs.contentType, encodingFlags, kWrapColumn);
} else {
dl.init(source, persistArgs.target, null, null, null, persist);
persist.saveURI(source, persistArgs.postData, persistArgs.target);
persist.saveURI(source, null, null, persistArgs.postData, null, persistArgs.target);
}
}