Skip to content

Commit

Permalink
Bug 1556656 - Restrict script access for some methods in nsIEditingSe…
Browse files Browse the repository at this point in the history 
…ssion r=masayuki

Some methods in `nsIEditingSession` isn't used from script. So we should move
these to `nsEditingSession` or add `[noscript]`.

Differential Revision: https://phabricator.services.mozilla.com/D33606
  • Loading branch information
@makotokato
makotokato committed Jun 6, 2019
1 parent 8613243 commit 2514a83
Show file tree
Hide file tree
Showing 5 changed files with 53 additions and 82 deletions.
10 changes: 3 additions & 7 deletions editor/composer/ComposerCommandsUpdater.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -199,13 +199,9 @@ ComposerCommandsUpdater::DidMerge(nsITransactionManager* aManager,
# pragma mark -
#endif

nsresult ComposerCommandsUpdater::Init(nsPIDOMWindowOuter* aDOMWindow) {
if (NS_WARN_IF(!aDOMWindow)) {
return NS_ERROR_INVALID_ARG;
}
mDOMWindow = aDOMWindow;
mDocShell = aDOMWindow->GetDocShell();
return NS_OK;
void ComposerCommandsUpdater::Init(nsPIDOMWindowOuter& aDOMWindow) {
mDOMWindow = &aDOMWindow;
mDocShell = aDOMWindow.GetDocShell();
}

nsresult ComposerCommandsUpdater::PrimeUpdateTimer() {
Expand Down
2 changes: 1 addition & 1 deletion editor/composer/ComposerCommandsUpdater.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ class ComposerCommandsUpdater final : public nsIDocumentStateListener,
// nsITransactionListener
NS_DECL_NSITRANSACTIONLISTENER

nsresult Init(nsPIDOMWindowOuter* aDOMWindow);
void Init(nsPIDOMWindowOuter& aDOMWindow);

/**
* OnSelectionChange() is called when selection is changed in the editor.
Expand Down
76 changes: 25 additions & 51 deletions editor/composer/nsEditingSession.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ nsEditingSession::MakeWindowEditable(mozIDOMWindowProxy* aWindow,

// aDoAfterUriLoad can be false only when making an existing window editable
if (!aDoAfterUriLoad) {
rv = SetupEditorOnWindow(aWindow);
rv = SetupEditorOnWindow(MOZ_KnownLive(*window));

// mEditorStatus is set to the error reason
// Since this is used only when editing an existing page,
Expand Down Expand Up @@ -266,29 +266,17 @@ bool IsSupportedTextType(const char* aMIMEType) {
return false;
}

/*---------------------------------------------------------------------------
SetupEditorOnWindow
nsIEditor setupEditorOnWindow (in nsIDOMWindow aWindow);
----------------------------------------------------------------------------*/
NS_IMETHODIMP
nsEditingSession::SetupEditorOnWindow(mozIDOMWindowProxy* aWindow) {
nsresult nsEditingSession::SetupEditorOnWindow(nsPIDOMWindowOuter& aWindow) {
mDoneSetup = true;

NS_ENSURE_TRUE(aWindow, NS_ERROR_FAILURE);
auto* window = nsPIDOMWindowOuter::From(aWindow);

nsresult rv;

// MIME CHECKING
// must get the content type
// Note: the doc gets this from the network channel during StartPageLoad,
// so we don't have to get it from there ourselves
nsAutoCString mimeCType;

// then lets check the mime type
if (RefPtr<Document> doc = window->GetDoc()) {
if (RefPtr<Document> doc = aWindow.GetDoc()) {
nsAutoString mimeType;
doc->GetContentType(mimeType);
AppendUTF16toUTF8(mimeType, mimeCType);
Expand Down Expand Up @@ -348,8 +336,7 @@ nsEditingSession::SetupEditorOnWindow(mozIDOMWindowProxy* aWindow) {
// now init the state maintainer
// This allows notification of error state
// even if we don't create an editor
rv = mComposerCommandsUpdater->Init(window);
NS_ENSURE_SUCCESS(rv, rv);
mComposerCommandsUpdater->Init(aWindow);

if (mEditorStatus != eEditorCreationInProgress) {
RefPtr<ComposerCommandsUpdater> updater = mComposerCommandsUpdater;
Expand All @@ -366,7 +353,7 @@ nsEditingSession::SetupEditorOnWindow(mozIDOMWindowProxy* aWindow) {

// Create editor and do other things
// only if we haven't found some error above,
nsCOMPtr<nsIDocShell> docShell = window->GetDocShell();
nsCOMPtr<nsIDocShell> docShell = aWindow.GetDocShell();
NS_ENSURE_TRUE(docShell, NS_ERROR_FAILURE);
RefPtr<PresShell> presShell = docShell->GetPresShell();
if (NS_WARN_IF(!presShell)) {
Expand Down Expand Up @@ -401,14 +388,14 @@ nsEditingSession::SetupEditorOnWindow(mozIDOMWindowProxy* aWindow) {
do_GetWeakReference(static_cast<nsIEditor*>(htmlEditor.get()));
}
// set the editor on the docShell. The docShell now owns it.
rv = docShell->SetHTMLEditor(htmlEditor);
nsresult rv = docShell->SetHTMLEditor(htmlEditor);
NS_ENSURE_SUCCESS(rv, rv);

// setup the HTML editor command controller
if (needHTMLController) {
// The third controller takes an nsIEditor as the context
rv = SetupEditorCommandController(
nsBaseCommandController::CreateHTMLEditorController, aWindow,
nsBaseCommandController::CreateHTMLEditorController, &aWindow,
static_cast<nsIEditor*>(htmlEditor), &mHTMLCommandControllerId);
NS_ENSURE_SUCCESS(rv, rv);
}
Expand Down Expand Up @@ -523,7 +510,7 @@ nsEditingSession::TearDownEditorOnWindow(mozIDOMWindowProxy* aWindow) {
if (mComposerCommandsUpdater && htmlEditor) {
// Null out the editor on the controllers first to prevent their weak
// references from pointing to a destroyed editor.
SetEditorOnControllers(aWindow, nullptr);
SetEditorOnControllers(*window, nullptr);
}

// Null out the editor on the docShell to trigger PreDestroy which
Expand Down Expand Up @@ -879,7 +866,8 @@ nsresult nsEditingSession::EndDocumentLoad(nsIWebProgress* aWebProgress,
mEditorStatus = eEditorErrorFileNotFound;
}

nsIDocShell* docShell = nsPIDOMWindowOuter::From(domWindow)->GetDocShell();
auto* window = nsPIDOMWindowOuter::From(domWindow);
nsIDocShell* docShell = window->GetDocShell();
NS_ENSURE_TRUE(docShell, NS_ERROR_FAILURE); // better error handling?

// cancel refresh from meta tags
Expand Down Expand Up @@ -910,7 +898,7 @@ nsresult nsEditingSession::EndDocumentLoad(nsIWebProgress* aWebProgress,

if (needsSetup) {
mCanCreateEditor = false;
rv = SetupEditorOnWindow(domWindow);
rv = SetupEditorOnWindow(MOZ_KnownLive(*window));
if (NS_FAILED(rv)) {
// If we had an error, setup timer to load a blank page later
if (mLoadBlankDocTimer) {
Expand Down Expand Up @@ -1087,24 +1075,13 @@ nsresult nsEditingSession::SetupEditorCommandController(
return SetContextOnControllerById(controllers, aContext, *aControllerId);
}

/*---------------------------------------------------------------------------
SetEditorOnControllers
Set the editor on the controller(s) for this window
----------------------------------------------------------------------------*/
NS_IMETHODIMP
nsEditingSession::SetEditorOnControllers(mozIDOMWindowProxy* aWindow,
nsIEditor* aEditor) {
NS_ENSURE_TRUE(aWindow, NS_ERROR_NULL_POINTER);

auto* piWindow = nsPIDOMWindowOuter::From(aWindow);

nsresult nsEditingSession::SetEditorOnControllers(nsPIDOMWindowOuter& aWindow,
HTMLEditor* aEditor) {
nsCOMPtr<nsIControllers> controllers;
nsresult rv = piWindow->GetControllers(getter_AddRefs(controllers));
nsresult rv = aWindow.GetControllers(getter_AddRefs(controllers));
NS_ENSURE_SUCCESS(rv, rv);

nsCOMPtr<nsISupports> editorAsISupports = static_cast<nsISupports*>(aEditor);
nsCOMPtr<nsISupports> editorAsISupports = static_cast<nsIEditor*>(aEditor);
if (mBaseCommandControllerId) {
rv = SetContextOnControllerById(controllers, editorAsISupports,
mBaseCommandControllerId);
Expand Down Expand Up @@ -1209,7 +1186,7 @@ void nsEditingSession::RestoreAnimationMode(nsPIDOMWindowOuter* aWindow) {
presContext->SetImageAnimationMode(mImageAnimationMode);
}

nsresult nsEditingSession::DetachFromWindow(mozIDOMWindowProxy* aWindow) {
nsresult nsEditingSession::DetachFromWindow(nsPIDOMWindowOuter* aWindow) {
NS_ENSURE_TRUE(mDoneSetup, NS_OK);

NS_ASSERTION(mComposerCommandsUpdater,
Expand All @@ -1221,14 +1198,12 @@ nsresult nsEditingSession::DetachFromWindow(mozIDOMWindowProxy* aWindow) {
mLoadBlankDocTimer = nullptr;
}

auto* window = nsPIDOMWindowOuter::From(aWindow);

// Remove controllers, webprogress listener, and otherwise
// make things the way they were before we started editing.
RemoveEditorControllers(window);
RemoveWebProgressListener(window);
RestoreJSAndPlugins(window);
RestoreAnimationMode(window);
RemoveEditorControllers(aWindow);
RemoveWebProgressListener(aWindow);
RestoreJSAndPlugins(aWindow);
RestoreAnimationMode(aWindow);

// Kill our weak reference to our original window, in case
// it changes on restore, or otherwise dies.
Expand All @@ -1237,7 +1212,7 @@ nsresult nsEditingSession::DetachFromWindow(mozIDOMWindowProxy* aWindow) {
return NS_OK;
}

nsresult nsEditingSession::ReattachToWindow(mozIDOMWindowProxy* aWindow) {
nsresult nsEditingSession::ReattachToWindow(nsPIDOMWindowOuter* aWindow) {
NS_ENSURE_TRUE(mDoneSetup, NS_OK);
NS_ENSURE_TRUE(aWindow, NS_ERROR_FAILURE);

Expand All @@ -1248,8 +1223,7 @@ nsresult nsEditingSession::ReattachToWindow(mozIDOMWindowProxy* aWindow) {
// old editor ot the window.
nsresult rv;

auto* window = nsPIDOMWindowOuter::From(aWindow);
nsIDocShell* docShell = window->GetDocShell();
nsIDocShell* docShell = aWindow->GetDocShell();
NS_ENSURE_TRUE(docShell, NS_ERROR_FAILURE);
mDocShell = do_GetWeakReference(docShell);

Expand All @@ -1263,7 +1237,7 @@ nsresult nsEditingSession::ReattachToWindow(mozIDOMWindowProxy* aWindow) {
mEditorStatus = eEditorCreationInProgress;

// Adds back web progress listener.
rv = PrepareForEditing(window);
rv = PrepareForEditing(aWindow);
NS_ENSURE_SUCCESS(rv, rv);

// Setup the command controllers again.
Expand All @@ -1278,7 +1252,7 @@ nsresult nsEditingSession::ReattachToWindow(mozIDOMWindowProxy* aWindow) {
NS_ENSURE_SUCCESS(rv, rv);

if (mComposerCommandsUpdater) {
mComposerCommandsUpdater->Init(window);
mComposerCommandsUpdater->Init(*aWindow);
}

// Get editor
Expand Down Expand Up @@ -1307,7 +1281,7 @@ nsresult nsEditingSession::ReattachToWindow(mozIDOMWindowProxy* aWindow) {
NS_ENSURE_SUCCESS(rv, rv);

// Set context on all controllers to be the editor
rv = SetEditorOnControllers(aWindow, htmlEditor);
rv = SetEditorOnControllers(*aWindow, htmlEditor);
NS_ENSURE_SUCCESS(rv, rv);

#ifdef DEBUG
Expand Down
24 changes: 23 additions & 1 deletion editor/composer/nsEditingSession.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ class nsITimer;
class nsIChannel;
class nsIControllers;
class nsIDocShell;
class nsIEditor;
class nsIWebProgress;

namespace mozilla {
Expand All @@ -53,6 +52,18 @@ class nsEditingSession final : public nsIEditingSession,
// nsIEditingSession
NS_DECL_NSIEDITINGSESSION

/**
* Removes all the editor's controllers/listeners etc and makes the window
* uneditable.
*/
nsresult DetachFromWindow(nsPIDOMWindowOuter* aWindow);

/**
* Undos DetachFromWindow(), reattaches this editing session/editor
* to the window.
*/
nsresult ReattachToWindow(nsPIDOMWindowOuter* aWindow);

protected:
virtual ~nsEditingSession();

Expand All @@ -65,6 +76,17 @@ class nsEditingSession final : public nsIEditingSession,
nsresult SetContextOnControllerById(nsIControllers* aControllers,
nsISupports* aContext, uint32_t aID);

/**
* Set the editor on the controller(s) for this window
*/
nsresult SetEditorOnControllers(nsPIDOMWindowOuter& aWindow,
mozilla::HTMLEditor* aEditor);

/**
* Setup editor and related support objects
*/
MOZ_CAN_RUN_SCRIPT nsresult SetupEditorOnWindow(nsPIDOMWindowOuter& aWindow);

nsresult PrepareForEditing(nsPIDOMWindowOuter* aWindow);

static void TimerCallback(nsITimer* aTimer, void* aClosure);
Expand Down
23 changes: 1 addition & 22 deletions editor/composer/nsIEditingSession.idl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,31 +67,10 @@ interface nsIEditingSession : nsISupports
*/
nsIEditor getEditorForWindow(in mozIDOMWindowProxy window);

/**
* Setup editor and related support objects
*/
[can_run_script]
void setupEditorOnWindow(in mozIDOMWindowProxy window);

/**
* Destroy editor and related support objects
*/
void tearDownEditorOnWindow(in mozIDOMWindowProxy window);

void setEditorOnControllers(in mozIDOMWindowProxy aWindow,
in nsIEditor aEditor);

/**
* Removes all the editor's controllers/listeners etc and makes the window
* uneditable.
*/
void detachFromWindow(in mozIDOMWindowProxy aWindow);

/**
* Undos detachFromWindow(), reattaches this editing session/editor
* to the window.
*/
void reattachToWindow(in mozIDOMWindowProxy aWindow);
[noscript] void tearDownEditorOnWindow(in mozIDOMWindowProxy window);

%{C++
/**
Expand Down

0 comments on commit 2514a83

Please sign in to comment.